blob: b5102c89c3c797ce795afe6dcd1c51f790f9ea08 [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>KafkaSourceConfig - io.gearpump.streaming.kafka.lib.KafkaSourceConfig</title>
<meta name="description" content="KafkaSourceConfig - io.gearpump.streaming.kafka.lib.KafkaSourceConfig" />
<meta name="keywords" content="KafkaSourceConfig io.gearpump.streaming.kafka.lib.KafkaSourceConfig" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../../../lib/template.js"></script>
<script type="text/javascript" src="../../../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../../../index.html';
var hash = 'io.gearpump.streaming.kafka.lib.KafkaSourceConfig';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="type">
<div id="definition">
<a href="KafkaSourceConfig$.html" title="Go to companion"><img src="../../../../../lib/class_to_object_big.png" /></a>
<p id="owner"><a href="../../../../package.html" class="extype" name="io">io</a>.<a href="../../../package.html" class="extype" name="io.gearpump">gearpump</a>.<a href="../../package.html" class="extype" name="io.gearpump.streaming">streaming</a>.<a href="../package.html" class="extype" name="io.gearpump.streaming.kafka">kafka</a>.<a href="package.html" class="extype" name="io.gearpump.streaming.kafka.lib">lib</a></p>
<h1><a href="KafkaSourceConfig$.html" title="Go to companion">KafkaSourceConfig</a></h1><h3><span class="morelinks"><div>
Related Docs:
<a href="KafkaSourceConfig$.html" title="See companion">object KafkaSourceConfig</a>
| <a href="package.html" class="extype" name="io.gearpump.streaming.kafka.lib">package lib</a>
</div></span></h3><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<span class="name">KafkaSourceConfig</span><span class="result"> extends <span class="extype" name="java.io.Serializable">Serializable</span></span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>this class extends kafka kafka.consumer.ConsumerConfig with specific configs for <a href="../KafkaSource.html" class="extype" name="io.gearpump.streaming.kafka.KafkaSource">KafkaSource</a>
</p></div><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig"><span>KafkaSourceConfig</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show all</span></li>
</ol>
<a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="constructors" class="members">
<h3>Instance Constructors</h3>
<ol><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(consumerProps:java.util.Properties):io.gearpump.streaming.kafka.lib.KafkaSourceConfig"></a>
<a id="&lt;init&gt;:KafkaSourceConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">KafkaSourceConfig</span><span class="params">(<span name="consumerProps">consumerProps: <span class="extype" name="java.util.Properties">Properties</span> = <span class="symbol">new Properties</span></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@&lt;init&gt;(consumerProps:java.util.Properties):io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">consumerProps</dt><dd class="cmt"><p>kafka consumer config
</p></dd></dl></div>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="!=(x$1:Any):Boolean"></a>
<a id="!=(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@!=(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="##():Int"></a>
<a id="##():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@##():Int" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="==(x$1:Any):Boolean"></a>
<a id="==(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@==(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="asInstanceOf[T0]:T0"></a>
<a id="asInstanceOf[T0]:T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@asInstanceOf[T0]:T0" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="clone():Object"></a>
<a id="clone():AnyRef"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@clone():Object" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#consumerConfig" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="consumerConfig:kafka.consumer.ConsumerConfig"></a>
<a id="consumerConfig:ConsumerConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">consumerConfig</span><span class="result">: <span class="extype" name="kafka.consumer.ConsumerConfig">ConsumerConfig</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@consumerConfig:kafka.consumer.ConsumerConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#consumerProps" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="consumerProps:java.util.Properties"></a>
<a id="consumerProps:Properties"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">val</span>
</span>
<span class="symbol">
<span class="name">consumerProps</span><span class="result">: <span class="extype" name="java.util.Properties">Properties</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@consumerProps:java.util.Properties" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">kafka consumer config
</p>
</li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="eq(x$1:AnyRef):Boolean"></a>
<a id="eq(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="equals(x$1:Any):Boolean"></a>
<a id="equals(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@equals(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="finalize():Unit"></a>
<a id="finalize():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@finalize():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="symbol">classOf[java.lang.Throwable]</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getClass():Class[_]"></a>
<a id="getClass():Class[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@getClass():Class[_]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#getConsumerStartOffset" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="getConsumerStartOffset:Long"></a>
<a id="getConsumerStartOffset:Long"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getConsumerStartOffset</span><span class="result">: <span class="extype" name="scala.Long">Long</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@getConsumerStartOffset:Long" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#getConsumerTopics" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getConsumerTopics:List[String]"></a>
<a id="getConsumerTopics:List[String]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getConsumerTopics</span><span class="result">: <span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@getConsumerTopics:List[String]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a list of kafka consumer topics
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#getFetchSleepMS" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getFetchSleepMS:Int"></a>
<a id="getFetchSleepMS:Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getFetchSleepMS</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@getFetchSleepMS:Int" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"><span class="extype" name="consumer.FetchThread">consumer.FetchThread</span> will sleep for a while if no more messages or
the incoming queue size is above the <a href="KafkaSourceConfig$.html#FETCH_THRESHOLD:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#FETCH_THRESHOLD">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.FETCH_THRESHOLD</a>
this is to get sleep interval</p><div class="fullcomment"><div class="comment cmt"><p><span class="extype" name="consumer.FetchThread">consumer.FetchThread</span> will sleep for a while if no more messages or
the incoming queue size is above the <a href="KafkaSourceConfig$.html#FETCH_THRESHOLD:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#FETCH_THRESHOLD">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.FETCH_THRESHOLD</a>
this is to get sleep interval</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>sleep interval in milliseconds
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#getFetchThreshold" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getFetchThreshold:Int"></a>
<a id="getFetchThreshold:Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getFetchThreshold</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@getFetchThreshold:Int" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"><span class="extype" name="io.gearpump.streaming.kafka.lib.consumer.FetchThread">io.gearpump.streaming.kafka.lib.consumer.FetchThread</span> stops fetching new messages if its incoming queue
size is above the threshold and starts again when the queue size is below it</p><div class="fullcomment"><div class="comment cmt"><p><span class="extype" name="io.gearpump.streaming.kafka.lib.consumer.FetchThread">io.gearpump.streaming.kafka.lib.consumer.FetchThread</span> stops fetching new messages if its incoming queue
size is above the threshold and starts again when the queue size is below it</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>fetch threshold
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#getGrouper" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getGrouper:io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper"></a>
<a id="getGrouper:KafkaGrouper"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getGrouper</span><span class="result">: <a href="grouper/KafkaGrouper.html" class="extype" name="io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper">KafkaGrouper</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@getGrouper:io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">get <a href="grouper/KafkaGrouper.html" class="extype" name="io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper">io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper</a> instance, which
defines how kafka.common.TopicAndPartitions are mapped to source tasks</p><div class="fullcomment"><div class="comment cmt"><p>get <a href="grouper/KafkaGrouper.html" class="extype" name="io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper">io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper</a> instance, which
defines how kafka.common.TopicAndPartitions are mapped to source tasks</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>
</p></dd></dl></div>
</li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="hashCode():Int"></a>
<a id="hashCode():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@hashCode():Int" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="isInstanceOf[T0]:Boolean"></a>
<a id="isInstanceOf[T0]:Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@isInstanceOf[T0]:Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="ne(x$1:AnyRef):Boolean"></a>
<a id="ne(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notify():Unit"></a>
<a id="notify():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@notify():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notifyAll():Unit"></a>
<a id="notifyAll():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@notifyAll():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
<a id="synchronized[T0](⇒T0):T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@synchronized[T0](x$1:=&gt;T0):T0" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="toString():String"></a>
<a id="toString():String"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@toString():String" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait():Unit"></a>
<a id="wait():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@wait():Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long,x$2:Int):Unit"></a>
<a id="wait(Long,Int):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long):Unit"></a>
<a id="wait(Long):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@wait(x$1:Long):Unit" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#withConsumerStartOffset" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="withConsumerStartOffset(earliestOrLatest:Long):io.gearpump.streaming.kafka.lib.KafkaSourceConfig"></a>
<a id="withConsumerStartOffset(Long):KafkaSourceConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">withConsumerStartOffset</span><span class="params">(<span name="earliestOrLatest">earliestOrLatest: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <a href="" class="extype" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig">KafkaSourceConfig</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@withConsumerStartOffset(earliestOrLatest:Long):io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#withConsumerTopics" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="withConsumerTopics(topics:String):io.gearpump.streaming.kafka.lib.KafkaSourceConfig"></a>
<a id="withConsumerTopics(String):KafkaSourceConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">withConsumerTopics</span><span class="params">(<span name="topics">topics: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="" class="extype" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig">KafkaSourceConfig</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@withConsumerTopics(topics:String):io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">set kafka consumer topics</p><div class="fullcomment"><div class="comment cmt"><p>set kafka consumer topics</p></div><dl class="paramcmts block"><dt class="param">topics</dt><dd class="cmt"><p>comma-separated string</p></dd><dt>returns</dt><dd class="cmt"><p>new KafkaConfig based on this but with <a href="KafkaSourceConfig$.html#CONSUMER_TOPICS:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#CONSUMER_TOPICS">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.CONSUMER_TOPICS</a> set to given value
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#withFetchSleepMS" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="withFetchSleepMS(sleepMS:Int):io.gearpump.streaming.kafka.lib.KafkaSourceConfig"></a>
<a id="withFetchSleepMS(Int):KafkaSourceConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">withFetchSleepMS</span><span class="params">(<span name="sleepMS">sleepMS: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <a href="" class="extype" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig">KafkaSourceConfig</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@withFetchSleepMS(sleepMS:Int):io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"><span class="extype" name="consumer.FetchThread">consumer.FetchThread</span> will sleep for a while if no more messages or
the incoming queue size is above the <a href="KafkaSourceConfig$.html#FETCH_THRESHOLD:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#FETCH_THRESHOLD">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.FETCH_THRESHOLD</a>
this is to set sleep interval</p><div class="fullcomment"><div class="comment cmt"><p><span class="extype" name="consumer.FetchThread">consumer.FetchThread</span> will sleep for a while if no more messages or
the incoming queue size is above the <a href="KafkaSourceConfig$.html#FETCH_THRESHOLD:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#FETCH_THRESHOLD">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.FETCH_THRESHOLD</a>
this is to set sleep interval</p></div><dl class="paramcmts block"><dt class="param">sleepMS</dt><dd class="cmt"><p>sleep interval in milliseconds</p></dd><dt>returns</dt><dd class="cmt"><p>new KafkaConfig based on this but with <a href="KafkaSourceConfig$.html#FETCH_SLEEP_MS:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#FETCH_SLEEP_MS">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.FETCH_SLEEP_MS</a> set to given value
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#withFetchThreshold" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="withFetchThreshold(threshold:Int):io.gearpump.streaming.kafka.lib.KafkaSourceConfig"></a>
<a id="withFetchThreshold(Int):KafkaSourceConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">withFetchThreshold</span><span class="params">(<span name="threshold">threshold: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <a href="" class="extype" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig">KafkaSourceConfig</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@withFetchThreshold(threshold:Int):io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"><span class="extype" name="consumer.FetchThread">consumer.FetchThread</span> stops fetching new messages if its incoming queue
size is above the threshold and starts again when the queue size is below it</p><div class="fullcomment"><div class="comment cmt"><p><span class="extype" name="consumer.FetchThread">consumer.FetchThread</span> stops fetching new messages if its incoming queue
size is above the threshold and starts again when the queue size is below it</p></div><dl class="paramcmts block"><dt class="param">threshold</dt><dd class="cmt"><p>queue size</p></dd><dt>returns</dt><dd class="cmt"><p>new KafkaConfig based on this but with <a href="KafkaSourceConfig$.html#FETCH_THRESHOLD:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#FETCH_THRESHOLD">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.FETCH_THRESHOLD</a> set to give value
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#withGrouper" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="withGrouper(className:String):io.gearpump.streaming.kafka.lib.KafkaSourceConfig"></a>
<a id="withGrouper(String):KafkaSourceConfig"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">withGrouper</span><span class="params">(<span name="className">className: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="" class="extype" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig">KafkaSourceConfig</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#io.gearpump.streaming.kafka.lib.KafkaSourceConfig@withGrouper(className:String):io.gearpump.streaming.kafka.lib.KafkaSourceConfig" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">set <a href="grouper/KafkaGrouper.html" class="extype" name="io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper">io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper</a>, which
defines how kafka.common.TopicAndPartitions are mapped to source tasks
</p><div class="fullcomment"><div class="comment cmt"><p>set <a href="grouper/KafkaGrouper.html" class="extype" name="io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper">io.gearpump.streaming.kafka.lib.grouper.KafkaGrouper</a>, which
defines how kafka.common.TopicAndPartitions are mapped to source tasks
</p></div><dl class="paramcmts block"><dt class="param">className</dt><dd class="cmt"><p>name of the factory class</p></dd><dt>returns</dt><dd class="cmt"><p>new KafkaConfig based on this but with <a href="KafkaSourceConfig$.html#GROUPER_CLASS:String" class="extmbr" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig#GROUPER_CLASS">io.gearpump.streaming.kafka.lib.KafkaSourceConfig.GROUPER_CLASS</a> set to given value
</p></dd></dl></div>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="java.io.Serializable">
<h3>Inherited from <span class="extype" name="java.io.Serializable">Serializable</span></h3>
</div><div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>