Docs for 0.10.0.0, release candidate 2 Squashed commit of the following:
commit bce7ff5165c98baf086741961e978a90e93277e8 Author: Gwen Shapira <[email protected]> Date: Mon Mar 28 14:23:19 2016 -0700 Remove Scaladoc. Its tons of file and we didn't have it on the site before commit 04bcb2217461065faa023c0f6eba9449eda9898f Author: Gwen Shapira <[email protected]> Date: Mon Mar 28 13:21:38 2016 -0700 adding javadoc and scaladoc commit 7c439b335b7c53d7f55e857195335396a57f6e33 Author: Gwen Shapira <[email protected]> Date: Mon Mar 28 13:08:04 2016 -0700 update docs for 0.10.0-rc1 Project: http://git-wip-us.apache.org/repos/asf/kafka-site/repo Commit: http://git-wip-us.apache.org/repos/asf/kafka-site/commit/46fccbe1 Tree: http://git-wip-us.apache.org/repos/asf/kafka-site/tree/46fccbe1 Diff: http://git-wip-us.apache.org/repos/asf/kafka-site/diff/46fccbe1 Branch: refs/heads/asf-site Commit: 46fccbe1e0b8415ad889619b3a8ee603470b9a96 Parents: 4ed4dd1 Author: Gwen Shapira <[email protected]> Authored: Mon Mar 28 14:25:50 2016 -0700 Committer: Gwen Shapira <[email protected]> Committed: Mon Mar 28 14:25:50 2016 -0700 ---------------------------------------------------------------------- 0100/api.html | 8 +- 0100/configuration.html | 5 + 0100/documentation.html | 15 + 0100/generated/connect_config.html | 2 +- 0100/generated/consumer_config.html | 6 +- 0100/generated/kafka_config.html | 20 +- 0100/generated/producer_config.html | 2 +- 0100/generated/protocol_errors.html | 2 +- 0100/generated/streams_config.html | 48 ++ 0100/javadoc/allclasses-frame.html | 19 + 0100/javadoc/allclasses-noframe.html | 19 + 0100/javadoc/constant-values.html | 111 +++++ 0100/javadoc/deprecated-list.html | 111 +++++ 0100/javadoc/help-doc.html | 208 ++++++++ 0100/javadoc/index-all.html | 183 +++++++ 0100/javadoc/index.html | 71 +++ .../javaapi/consumer/ConsumerConnector.html | 361 ++++++++++++++ .../consumer/ConsumerRebalanceListener.html | 236 +++++++++ .../kafka/javaapi/consumer/package-frame.html | 20 + .../kafka/javaapi/consumer/package-summary.html | 136 ++++++ .../kafka/javaapi/consumer/package-tree.html | 117 +++++ 0100/javadoc/overview-tree.html | 121 +++++ 0100/javadoc/package-list | 1 + 0100/javadoc/resources/background.gif | Bin 0 -> 2313 bytes 0100/javadoc/resources/tab.gif | Bin 0 -> 291 bytes 0100/javadoc/resources/titlebar.gif | Bin 0 -> 10701 bytes 0100/javadoc/resources/titlebar_end.gif | Bin 0 -> 849 bytes 0100/javadoc/stylesheet.css | 474 +++++++++++++++++++ 0100/ops.html | 2 + 0100/quickstart.html | 115 ++++- 0100/streams.html | 341 +++++++++++++ 0100/upgrade.html | 9 +- 32 files changed, 2741 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/api.html ---------------------------------------------------------------------- diff --git a/0100/api.html b/0100/api.html index 2541553..d303244 100644 --- a/0100/api.html +++ b/0100/api.html @@ -24,12 +24,12 @@ We encourage all new development to use the new Java producer. This client is pr <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> - <version>0.9.0.0</version> + <version>0.10.0.0</version> </dependency> </pre> Examples showing how to use the producer are given in the -<a href="http://kafka.apache.org/090/javadoc/index.html?org/apache/kafka/clients/producer/KafkaProducer.html"; title="Kafka 0.9.0 Javadoc">javadocs</a>. +<a href="http://kafka.apache.org/0100/javadoc/index.html?org/apache/kafka/clients/producer/KafkaProducer.html"; title="Kafka 0.10.0 Javadoc">javadocs</a>. <p> For those interested in the legacy Scala producer api, information can be found <a href="http://kafka.apache.org/081/documentation.html#producerapi";> @@ -159,9 +159,9 @@ This new unified consumer API removes the distinction between the 0.8 high-level <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> - <version>0.9.0.0</version> + <version>0.10.0.0</version> </dependency> </pre> Examples showing how to use the consumer are given in the -<a href="http://kafka.apache.org/090/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html"; title="Kafka 0.9.0 Javadoc">javadocs</a>. +<a href="http://kafka.apache.org/0100/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html"; title="Kafka 0.9.0 Javadoc">javadocs</a>. http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/configuration.html ---------------------------------------------------------------------- diff --git a/0100/configuration.html b/0100/configuration.html index a89778d..e5280a5 100644 --- a/0100/configuration.html +++ b/0100/configuration.html @@ -333,4 +333,9 @@ Since 0.9.0.0 we have been working on a replacement for our existing simple and <!--#include virtual="generated/consumer_config.html" --> <h3><a id="connectconfigs" href="#connectconfigs">3.4 Kafka Connect Configs</a></h3> +Below is the configuration of the Kafka Connect framework. <!--#include virtual="generated/connect_config.html" --> + +<h3><a id="streamsconfigs" href="#streamsconfigs">3.5 Kafka Streams Configs</a></h3> +Below is the configuration of the Kafka Streams client library. +<!--#include virtual="generated/streams_config.html" --> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/documentation.html ---------------------------------------------------------------------- diff --git a/0100/documentation.html b/0100/documentation.html index 67a2954..70002ab 100644 --- a/0100/documentation.html +++ b/0100/documentation.html @@ -52,6 +52,7 @@ Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documen <li><a href="#newconsumerconfigs">3.3.2 New Consumer Configs</a> </ul> <li><a href="#connectconfigs">3.4 Kafka Connect Configs</a> + <li><a href="#streamsconfigs">3.5 Kafka Streams Configs</a> </ul> </li> <li><a href="#design">4. Design</a> @@ -136,6 +137,17 @@ Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documen <li><a href="#connect_development">8.3 Connector Development Guide</a></li> </ul> </li> + <li><a href="#streams">9. Kafka Streams</a> + <ul> + <li><a href="#streams_overview">9.1 Overview</a></li> + <li><a href="#streams_developer">9.2 Developer Guide</a></li> + <ul> + <li><a href="#streams_concepts">Core Concepts</a></li> + <li><a href="#streams_processor">Low-Level Processor API</a></li> + <li><a href="#streams_dsl">High-Level Streams DSL</a></li> + </ul> + </ul> + </li> </ul> <h2><a id="gettingStarted" href="#gettingStarted">1. Getting Started</a></h2> @@ -171,4 +183,7 @@ Prior releases: <a href="/07/documentation.html">0.7.x</a>, <a href="/08/documen <h2><a id="connect" href="#connect">8. Kafka Connect</a></h2> <!--#include virtual="connect.html" --> +<h2><a id="streams" href="#streams">9. Kafka Streams</a></h2> +<!--#include virtual="streams.html" --> + <!--#include virtual="../includes/footer.html" --> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/generated/connect_config.html ---------------------------------------------------------------------- diff --git a/0100/generated/connect_config.html b/0100/generated/connect_config.html index 3b3afb6..6a8e91b 100644 --- a/0100/generated/connect_config.html +++ b/0100/generated/connect_config.html @@ -78,7 +78,7 @@ <tr> <td>metrics.num.samples</td><td>The number of samples maintained to compute metrics.</td><td>int</td><td>2</td><td>[1,...]</td><td>low</td></tr> <tr> -<td>metrics.sample.window.ms</td><td>The number of samples maintained to compute metrics.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> +<td>metrics.sample.window.ms</td><td>The window of time a metrics sample is computed over.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> <tr> <td>offset.flush.interval.ms</td><td>Interval at which to try committing offsets for tasks.</td><td>long</td><td>60000</td><td></td><td>low</td></tr> <tr> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/generated/consumer_config.html ---------------------------------------------------------------------- diff --git a/0100/generated/consumer_config.html b/0100/generated/consumer_config.html index 9b5c78d..b8d9f75 100644 --- a/0100/generated/consumer_config.html +++ b/0100/generated/consumer_config.html @@ -22,7 +22,7 @@ <tr> <td>max.partition.fetch.bytes</td><td>The maximum amount of data per-partition the server will return. The maximum total memory used for a request will be <code>#partitions * max.partition.fetch.bytes</code>. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition.</td><td>int</td><td>1048576</td><td>[0,...]</td><td>high</td></tr> <tr> -<td>session.timeout.ms</td><td>The timeout used to detect failures when using Kafka's group management facilities.</td><td>int</td><td>30000</td><td></td><td>high</td></tr> +<td>session.timeout.ms</td><td>The timeout used to detect failures when using Kafka's group management facilities. When a consumer's heartbeat is not received within the session timeout, the broker will mark the consumer as failed and rebalance the group. Since heartbeats are sent only when poll() is invoked, a higher session timeout allows more time for message processing in the consumer's poll loop at the cost of a longer time to detect hard failures. See also <code>max.poll.records</code> for another option to control the processing time in the poll loop. Note that the value must be in the allowable range as configured in the broker configuration by <code>group.min.session.timeout.ms</code> and <code>group.max.session.timeout.ms</code>.</td><td>int</td><td>30000</td><td></td><td>high</td></tr> <tr> <td>ssl.key.password</td><td>The password of the private key in the key store file. This is optional for client.</td><td>password</td><td>null</td><td></td><td>high</td></tr> <tr> @@ -46,7 +46,7 @@ <tr> <td>partition.assignment.strategy</td><td>The class name of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used</td><td>list</td><td>[org.apache.kafka.clients.consumer.RangeAssignor]</td><td></td><td>medium</td></tr> <tr> -<td>receive.buffer.bytes</td><td>The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.</td><td>int</td><td>32768</td><td>[0,...]</td><td>medium</td></tr> +<td>receive.buffer.bytes</td><td>The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.</td><td>int</td><td>65536</td><td>[0,...]</td><td>medium</td></tr> <tr> <td>request.timeout.ms</td><td>The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted.</td><td>int</td><td>40000</td><td>[0,...]</td><td>medium</td></tr> <tr> @@ -82,7 +82,7 @@ <tr> <td>metrics.num.samples</td><td>The number of samples maintained to compute metrics.</td><td>int</td><td>2</td><td>[1,...]</td><td>low</td></tr> <tr> -<td>metrics.sample.window.ms</td><td>The number of samples maintained to compute metrics.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> +<td>metrics.sample.window.ms</td><td>The window of time a metrics sample is computed over.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> <tr> <td>reconnect.backoff.ms</td><td>The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker.</td><td>long</td><td>50</td><td>[0,...]</td><td>low</td></tr> <tr> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/generated/kafka_config.html ---------------------------------------------------------------------- diff --git a/0100/generated/kafka_config.html b/0100/generated/kafka_config.html index b373a29..3858203 100644 --- a/0100/generated/kafka_config.html +++ b/0100/generated/kafka_config.html @@ -10,11 +10,13 @@ <tr> <td>zookeeper.connect</td><td>Zookeeper host string</td><td>string</td><td></td><td></td><td>high</td></tr> <tr> -<td>advertised.host.name</td><td>Hostname to publish to ZooKeeper for clients to use. In IaaS environments, this may need to be different from the interface to which the broker binds. If this is not set, it will use the value for "host.name" if configured. Otherwise it will use the value returned from java.net.InetAddress.getCanonicalHostName().</td><td>string</td><td>null</td><td></td><td>high</td></tr> +<td>advertised.host.name</td><td>DEPRECATED: only used when `advertised.listeners` or `listeners` are not set. Use `advertised.listeners` instead. +Hostname to publish to ZooKeeper for clients to use. In IaaS environments, this may need to be different from the interface to which the broker binds. If this is not set, it will use the value for `host.name` if configured. Otherwise it will use the value returned from java.net.InetAddress.getCanonicalHostName().</td><td>string</td><td>null</td><td></td><td>high</td></tr> <tr> -<td>advertised.listeners</td><td>Listeners to publish to ZooKeeper for clients to use, if different than the listeners above. In IaaS environments, this may need to be different from the interface to which the broker binds. If this is not set, the value for "listeners" will be used.</td><td>string</td><td>null</td><td></td><td>high</td></tr> +<td>advertised.listeners</td><td>Listeners to publish to ZooKeeper for clients to use, if different than the listeners above. In IaaS environments, this may need to be different from the interface to which the broker binds. If this is not set, the value for `listeners` will be used.</td><td>string</td><td>null</td><td></td><td>high</td></tr> <tr> -<td>advertised.port</td><td>The port to publish to ZooKeeper for clients to use. In IaaS environments, this may need to be different from the port to which the broker binds. If this is not set, it will publish the same port that the broker binds to.</td><td>int</td><td>null</td><td></td><td>high</td></tr> +<td>advertised.port</td><td>DEPRECATED: only used when `advertised.listeners` or `listeners` are not set. Use `advertised.listeners` instead. +The port to publish to ZooKeeper for clients to use. In IaaS environments, this may need to be different from the port to which the broker binds. If this is not set, it will publish the same port that the broker binds to.</td><td>int</td><td>null</td><td></td><td>high</td></tr> <tr> <td>auto.create.topics.enable</td><td>Enable auto creation of topic on the server</td><td>boolean</td><td>true</td><td></td><td>high</td></tr> <tr> @@ -28,7 +30,8 @@ <tr> <td>delete.topic.enable</td><td>Enables delete topic. Delete topic through the admin tool will have no effect if this config is turned off</td><td>boolean</td><td>false</td><td></td><td>high</td></tr> <tr> -<td>host.name</td><td>hostname of broker. If this is set, it will only bind to this address. If this is not set, it will bind to all interfaces</td><td>string</td><td>""</td><td></td><td>high</td></tr> +<td>host.name</td><td>DEPRECATED: only used when `listeners` is not set. Use `listeners` instead. +hostname of broker. If this is set, it will only bind to this address. If this is not set, it will bind to all interfaces</td><td>string</td><td>""</td><td></td><td>high</td></tr> <tr> <td>leader.imbalance.check.interval.seconds</td><td>The frequency with which the partition rebalance check is triggered by the controller</td><td>long</td><td>300</td><td></td><td>high</td></tr> <tr> @@ -106,7 +109,8 @@ <tr> <td>offsets.topic.segment.bytes</td><td>The offsets topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads</td><td>int</td><td>104857600</td><td>[1,...]</td><td>high</td></tr> <tr> -<td>port</td><td>the port to listen and accept connections on</td><td>int</td><td>9092</td><td></td><td>high</td></tr> +<td>port</td><td>DEPRECATED: only used when `listeners` is not set. Use `listeners` instead. +the port to listen and accept connections on</td><td>int</td><td>9092</td><td></td><td>high</td></tr> <tr> <td>queued.max.requests</td><td>The number of queued requests allowed before blocking the network threads</td><td>int</td><td>500</td><td>[1,...]</td><td>high</td></tr> <tr> @@ -162,9 +166,9 @@ <tr> <td>fetch.purgatory.purge.interval.requests</td><td>The purge interval (in number of requests) of the fetch request purgatory</td><td>int</td><td>1000</td><td></td><td>medium</td></tr> <tr> -<td>group.max.session.timeout.ms</td><td>The maximum allowed session timeout for registered consumers</td><td>int</td><td>30000</td><td></td><td>medium</td></tr> +<td>group.max.session.timeout.ms</td><td>The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.</td><td>int</td><td>30000</td><td></td><td>medium</td></tr> <tr> -<td>group.min.session.timeout.ms</td><td>The minimum allowed session timeout for registered consumers</td><td>int</td><td>6000</td><td></td><td>medium</td></tr> +<td>group.min.session.timeout.ms</td><td>The minimum allowed session timeout for registered consumers. Shorter timeouts leader to quicker failure detection at the cost of more frequent consumer heartbeating, which can overwhelm broker resources.</td><td>int</td><td>6000</td><td></td><td>medium</td></tr> <tr> <td>inter.broker.protocol.version</td><td>Specify which version of the inter-broker protocol will be used. This is typically bumped after all brokers were upgraded to a new version. @@ -266,7 +270,7 @@ <tr> <td>metrics.num.samples</td><td>The number of samples maintained to compute metrics.</td><td>int</td><td>2</td><td>[1,...]</td><td>low</td></tr> <tr> -<td>metrics.sample.window.ms</td><td>The number of samples maintained to compute metrics.</td><td>long</td><td>30000</td><td>[1,...]</td><td>low</td></tr> +<td>metrics.sample.window.ms</td><td>The window of time a metrics sample is computed over.</td><td>long</td><td>30000</td><td>[1,...]</td><td>low</td></tr> <tr> <td>quota.window.num</td><td>The number of samples to retain in memory</td><td>int</td><td>11</td><td>[1,...]</td><td>low</td></tr> <tr> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/generated/producer_config.html ---------------------------------------------------------------------- diff --git a/0100/generated/producer_config.html b/0100/generated/producer_config.html index 3a10357..9735813 100644 --- a/0100/generated/producer_config.html +++ b/0100/generated/producer_config.html @@ -82,7 +82,7 @@ <tr> <td>metrics.num.samples</td><td>The number of samples maintained to compute metrics.</td><td>int</td><td>2</td><td>[1,...]</td><td>low</td></tr> <tr> -<td>metrics.sample.window.ms</td><td>The number of samples maintained to compute metrics.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> +<td>metrics.sample.window.ms</td><td>The window of time a metrics sample is computed over.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> <tr> <td>reconnect.backoff.ms</td><td>The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker.</td><td>long</td><td>50</td><td>[0,...]</td><td>low</td></tr> <tr> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/generated/protocol_errors.html ---------------------------------------------------------------------- diff --git a/0100/generated/protocol_errors.html b/0100/generated/protocol_errors.html index 650966f..f02670d 100644 --- a/0100/generated/protocol_errors.html +++ b/0100/generated/protocol_errors.html @@ -31,7 +31,7 @@ <tr><td>INCONSISTENT_GROUP_PROTOCOL</td><td>23</td><td>False</td><td>The group member's supported protocols are incompatible with those of existing members.</td></tr> <tr><td>INVALID_GROUP_ID</td><td>24</td><td>False</td><td>The configured groupId is invalid</td></tr> <tr><td>UNKNOWN_MEMBER_ID</td><td>25</td><td>False</td><td>The coordinator is not aware of this member.</td></tr> -<tr><td>INVALID_SESSION_TIMEOUT</td><td>26</td><td>False</td><td>The session timeout is not within an acceptable range.</td></tr> +<tr><td>INVALID_SESSION_TIMEOUT</td><td>26</td><td>False</td><td>The session timeout is not within the range allowed by the broker (as configured by group.min.session.timeout.ms and group.max.session.timeout.ms).</td></tr> <tr><td>REBALANCE_IN_PROGRESS</td><td>27</td><td>False</td><td>The group is rebalancing, so a rejoin is needed.</td></tr> <tr><td>INVALID_COMMIT_OFFSET_SIZE</td><td>28</td><td>False</td><td>The committing offset data size is not valid</td></tr> <tr><td>TOPIC_AUTHORIZATION_FAILED</td><td>29</td><td>False</td><td>Not authorized to access topics: [Topic authorization failed.]</td></tr> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/generated/streams_config.html ---------------------------------------------------------------------- diff --git a/0100/generated/streams_config.html b/0100/generated/streams_config.html new file mode 100644 index 0000000..bfa2d74 --- /dev/null +++ b/0100/generated/streams_config.html @@ -0,0 +1,48 @@ +<table class="data-table"><tbody> +<tr> +<th>Name</th> +<th>Description</th> +<th>Type</th> +<th>Default</th> +<th>Valid Values</th> +<th>Importance</th> +</tr> +<tr> +<td>application.id</td><td>An identifier for the stream processing application. Must be unique within the Kafka cluster. It is used as 1) the default client-id prefix, 2) the group-id for membership management, 3) the changelog topic prefix.</td><td>string</td><td></td><td></td><td>high</td></tr> +<tr> +<td>bootstrap.servers</td><td>A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form <code>host1:port1,host2:port2,...</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).</td><td>string</td><td></td><td></td><td>high</td></tr> +<tr> +<td>client.id</td><td>An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.</td><td>string</td><td>""</td><td></td><td>high</td></tr> +<tr> +<td>zookeeper.connect</td><td>Zookeeper connect string for Kafka topics management.</td><td>string</td><td>""</td><td></td><td>high</td></tr> +<tr> +<td>key.serde</td><td>Serializer / deserializer class for key that implements the <code>Serde</code> interface.</td><td>class</td><td>class org.apache.kafka.common.serialization.Serdes$ByteArraySerde</td><td></td><td>medium</td></tr> +<tr> +<td>partition.grouper</td><td>Partition grouper class that implements the <code>PartitionGrouper</code> interface.</td><td>class</td><td>class org.apache.kafka.streams.processor.DefaultPartitionGrouper</td><td></td><td>medium</td></tr> +<tr> +<td>replication.factor</td><td>The replication factor for change log topics and repartition topics created by the stream processing application.</td><td>int</td><td>1</td><td></td><td>medium</td></tr> +<tr> +<td>state.dir</td><td>Directory location for state store.</td><td>string</td><td>/tmp/kafka-streams</td><td></td><td>medium</td></tr> +<tr> +<td>timestamp.extractor</td><td>Timestamp extractor class that implements the <code>TimestampExtractor</code> interface.</td><td>class</td><td>class org.apache.kafka.streams.processor.ConsumerRecordTimestampExtractor</td><td></td><td>medium</td></tr> +<tr> +<td>value.serde</td><td>Serializer / deserializer class for value that implements the <code>Serde</code> interface.</td><td>class</td><td>class org.apache.kafka.common.serialization.Serdes$ByteArraySerde</td><td></td><td>medium</td></tr> +<tr> +<td>buffered.records.per.partition</td><td>The maximum number of records to buffer per partition.</td><td>int</td><td>1000</td><td></td><td>low</td></tr> +<tr> +<td>commit.interval.ms</td><td>The frequency with which to save the position of the processor.</td><td>long</td><td>30000</td><td></td><td>low</td></tr> +<tr> +<td>metric.reporters</td><td>A list of classes to use as metrics reporters. Implementing the <code>MetricReporter</code> interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics.</td><td>list</td><td>[]</td><td></td><td>low</td></tr> +<tr> +<td>metrics.num.samples</td><td>The number of samples maintained to compute metrics.</td><td>int</td><td>2</td><td>[1,...]</td><td>low</td></tr> +<tr> +<td>metrics.sample.window.ms</td><td>The window of time a metrics sample is computed over.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>num.standby.replicas</td><td>The number of standby replicas for each task.</td><td>int</td><td>0</td><td></td><td>low</td></tr> +<tr> +<td>num.stream.threads</td><td>The number of threads to execute stream processing.</td><td>int</td><td>1</td><td></td><td>low</td></tr> +<tr> +<td>poll.ms</td><td>The amount of time in milliseconds to block waiting for input.</td><td>long</td><td>100</td><td></td><td>low</td></tr> +<tr> +<td>state.cleanup.delay.ms</td><td>The amount of time in milliseconds to wait before deleting state when a partition has migrated.</td><td>long</td><td>60000</td><td></td><td>low</td></tr> +</tbody></table> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/allclasses-frame.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/allclasses-frame.html b/0100/javadoc/allclasses-frame.html new file mode 100644 index 0000000..a35164d --- /dev/null +++ b/0100/javadoc/allclasses-frame.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>All Classes (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar">All Classes</h1> +<div class="indexContainer"> +<ul> +<li><a href="kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer" target="classFrame"><i>ConsumerConnector</i></a></li> +<li><a href="kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer" target="classFrame"><i>ConsumerRebalanceListener</i></a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/allclasses-noframe.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/allclasses-noframe.html b/0100/javadoc/allclasses-noframe.html new file mode 100644 index 0000000..73432c5 --- /dev/null +++ b/0100/javadoc/allclasses-noframe.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>All Classes (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar">All Classes</h1> +<div class="indexContainer"> +<ul> +<li><a href="kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer"><i>ConsumerConnector</i></a></li> +<li><a href="kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer"><i>ConsumerRebalanceListener</i></a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/constant-values.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/constant-values.html b/0100/javadoc/constant-values.html new file mode 100644 index 0000000..526f48d --- /dev/null +++ b/0100/javadoc/constant-values.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>Constant Field Values (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Constant Field Values (core 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?constant-values.html" target="_top">Frames</a></li> +<li><a href="constant-values.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Constant Field Values" class="title">Constant Field Values</h1> +<h2 title="Contents">Contents</h2> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?constant-values.html" target="_top">Frames</a></li> +<li><a href="constant-values.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/deprecated-list.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/deprecated-list.html b/0100/javadoc/deprecated-list.html new file mode 100644 index 0000000..d7a8140 --- /dev/null +++ b/0100/javadoc/deprecated-list.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>Deprecated List (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Deprecated List (core 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li class="navBarCell1Rev">Deprecated</li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li> +<li><a href="deprecated-list.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Deprecated API" class="title">Deprecated API</h1> +<h2 title="Contents">Contents</h2> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li class="navBarCell1Rev">Deprecated</li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li> +<li><a href="deprecated-list.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/help-doc.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/help-doc.html b/0100/javadoc/help-doc.html new file mode 100644 index 0000000..3c44cf7 --- /dev/null +++ b/0100/javadoc/help-doc.html @@ -0,0 +1,208 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>API Help (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="API Help (core 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li class="navBarCell1Rev">Help</li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> +<li><a href="help-doc.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">How This API Document Is Organized</h1> +<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<h2>Package</h2> +<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p> +<ul> +<li>Interfaces (italic)</li> +<li>Classes</li> +<li>Enums</li> +<li>Exceptions</li> +<li>Errors</li> +<li>Annotation Types</li> +</ul> +</li> +<li class="blockList"> +<h2>Class/Interface</h2> +<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p> +<ul> +<li>Class inheritance diagram</li> +<li>Direct Subclasses</li> +<li>All Known Subinterfaces</li> +<li>All Known Implementing Classes</li> +<li>Class/interface declaration</li> +<li>Class/interface description</li> +</ul> +<ul> +<li>Nested Class Summary</li> +<li>Field Summary</li> +<li>Constructor Summary</li> +<li>Method Summary</li> +</ul> +<ul> +<li>Field Detail</li> +<li>Constructor Detail</li> +<li>Method Detail</li> +</ul> +<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> +</li> +<li class="blockList"> +<h2>Annotation Type</h2> +<p>Each annotation type has its own separate page with the following sections:</p> +<ul> +<li>Annotation Type declaration</li> +<li>Annotation Type description</li> +<li>Required Element Summary</li> +<li>Optional Element Summary</li> +<li>Element Detail</li> +</ul> +</li> +<li class="blockList"> +<h2>Enum</h2> +<p>Each enum has its own separate page with the following sections:</p> +<ul> +<li>Enum declaration</li> +<li>Enum description</li> +<li>Enum Constant Summary</li> +<li>Enum Constant Detail</li> +</ul> +</li> +<li class="blockList"> +<h2>Tree (Class Hierarchy)</h2> +<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p> +<ul> +<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> +<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> +</ul> +</li> +<li class="blockList"> +<h2>Deprecated API</h2> +<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> +</li> +<li class="blockList"> +<h2>Index</h2> +<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> +</li> +<li class="blockList"> +<h2>Prev/Next</h2> +<p>These links take you to the next or previous class, interface, package, or related page.</p> +</li> +<li class="blockList"> +<h2>Frames/No Frames</h2> +<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> +</li> +<li class="blockList"> +<h2>All Classes</h2> +<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> +</li> +<li class="blockList"> +<h2>Serialized Form</h2> +<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p> +</li> +<li class="blockList"> +<h2>Constant Field Values</h2> +<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> +</li> +</ul> +<em>This help file applies to API documentation generated using the standard doclet.</em></div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li class="navBarCell1Rev">Help</li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> +<li><a href="help-doc.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/index-all.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/index-all.html b/0100/javadoc/index-all.html new file mode 100644 index 0000000..5847195 --- /dev/null +++ b/0100/javadoc/index-all.html @@ -0,0 +1,183 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>Index (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Index (core 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="./kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="./overview-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="./allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_K_">K</a> <a href="#_S_">S</a> <a name="_B_"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerRebalanceListener.html#beforeReleasingPartitions(java.util.Map)">beforeReleasingPartitions(Map<String, Set<Integer>>)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer">ConsumerRebalanceListener</a></dt> +<dd> +<div class="block">This method is called after all the fetcher threads are stopped but before the + ownership of partitions are released.</div> +</dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerRebalanceListener.html#beforeStartingFetchers(java.lang.String,%20java.util.Map)">beforeStartingFetchers(String, Map<String, Map<Integer, ConsumerThreadId>>)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer">ConsumerRebalanceListener</a></dt> +<dd> +<div class="block">This method is called after the new partition assignment is finished but before fetcher + threads start.</div> +</dd> +</dl> +<a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#commitOffsets()">commitOffsets()</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> +<div class="block">Commit the offsets of all broker partitions connected by this connector.</div> +</dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#commitOffsets(boolean)">commitOffsets(boolean)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#commitOffsets(java.util.Map,%20boolean)">commitOffsets(Map<TopicAndPartition, OffsetAndMetadata>, boolean)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> +<div class="block">Commit offsets using the provided offsets map</div> +</dd> +<dt><a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer"><span class="strong">ConsumerConnector</span></a> - Interface in <a href="./kafka/javaapi/consumer/package-summary.html">kafka.javaapi.consumer</a></dt> +<dd> </dd> +<dt><a href="./kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer"><span class="strong">ConsumerRebalanceListener</span></a> - Interface in <a href="./kafka/javaapi/consumer/package-summary.html">kafka.javaapi.consumer</a></dt> +<dd> +<div class="block">This listener is used for execution of tasks defined by user when a consumer rebalance + occurs in <code>ZookeeperConsumerConnector</code></div> +</dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreams(java.util.Map,%20kafka.serializer.Decoder,%20kafka.serializer.Decoder)">createMessageStreams(Map<String, Integer>, Decoder<K>, Decoder<V>)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> +<div class="block">Create a list of MessageStreams of type T for each topic.</div> +</dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreams(java.util.Map)">createMessageStreams(Map<String, Integer>)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreamsByFilter(kafka.consumer.TopicFilter,%20int,%20kafka.serializer.Decoder,%20kafka.serializer.Decoder)">createMessageStreamsByFilter(TopicFilter, int, Decoder<K>, Decoder<V>)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> +<div class="block">Create a list of MessageAndTopicStreams containing messages of type T.</div> +</dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreamsByFilter(kafka.consumer.TopicFilter,%20int)">createMessageStreamsByFilter(TopicFilter, int)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreamsByFilter(kafka.consumer.TopicFilter)">createMessageStreamsByFilter(TopicFilter)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> </dd> +</dl> +<a name="_K_"> +<!-- --> +</a> +<h2 class="title">K</h2> +<dl> +<dt><a href="./kafka/javaapi/consumer/package-summary.html">kafka.javaapi.consumer</a> - package kafka.javaapi.consumer</dt> +<dd> </dd> +</dl> +<a name="_S_"> +<!-- --> +</a> +<h2 class="title">S</h2> +<dl> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#setConsumerRebalanceListener(kafka.javaapi.consumer.ConsumerRebalanceListener)">setConsumerRebalanceListener(ConsumerRebalanceListener)</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> +<div class="block">Wire in a consumer rebalance listener to be executed when consumer rebalance occurs.</div> +</dd> +<dt><span class="strong"><a href="./kafka/javaapi/consumer/ConsumerConnector.html#shutdown()">shutdown()</a></span> - Method in interface kafka.javaapi.consumer.<a href="./kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer">ConsumerConnector</a></dt> +<dd> +<div class="block">Shut down the connector</div> +</dd> +</dl> +<a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_K_">K</a> <a href="#_S_">S</a> </div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="./kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li>Class</li> +<li><a href="./overview-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="./allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/index.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/index.html b/0100/javadoc/index.html new file mode 100644 index 0000000..1ce32aa --- /dev/null +++ b/0100/javadoc/index.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc on Mon Mar 28 13:06:16 PDT 2016 --> +<title>core 0.10.0.0 API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +<frame src="kafka/javaapi/consumer/package-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="kafka/javaapi/consumer/package-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/kafka/javaapi/consumer/ConsumerConnector.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/kafka/javaapi/consumer/ConsumerConnector.html b/0100/javadoc/kafka/javaapi/consumer/ConsumerConnector.html new file mode 100644 index 0000000..bfb155d --- /dev/null +++ b/0100/javadoc/kafka/javaapi/consumer/ConsumerConnector.html @@ -0,0 +1,361 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>ConsumerConnector (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConsumerConnector (core 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?kafka/javaapi/consumer/ConsumerConnector.html" target="_top">Frames</a></li> +<li><a href="ConsumerConnector.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">kafka.javaapi.consumer</div> +<h2 title="Interface ConsumerConnector" class="title">Interface ConsumerConnector</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ConsumerConnector</span></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#commitOffsets()">commitOffsets</a></strong>()</code> +<div class="block">Commit the offsets of all broker partitions connected by this connector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#commitOffsets(boolean)">commitOffsets</a></strong>(boolean retryOnFailure)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#commitOffsets(java.util.Map,%20boolean)">commitOffsets</a></strong>(java.util.Map<kafka.common.TopicAndPartition,kafka.common.OffsetAndMetadata> offsetsToCommit, + boolean retryOnFailure)</code> +<div class="block">Commit offsets using the provided offsets map</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.util.List<kafka.consumer.KafkaStream<byte[],byte[]>>></code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreams(java.util.Map)">createMessageStreams</a></strong>(java.util.Map<java.lang.String,java.lang.Integer> topicCountMap)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><K,V> java.util.Map<java.lang.String,java.util.List<kafka.consumer.KafkaStream<K,V>>></code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreams(java.util.Map,%20kafka.serializer.Decoder,%20kafka.serializer.Decoder)">createMessageStreams</a></strong>(java.util.Map<java.lang.String,java.lang.Integer> topicCountMap, + kafka.serializer.Decoder<K> keyDecoder, + kafka.serializer.Decoder<V> valueDecoder)</code> +<div class="block">Create a list of MessageStreams of type T for each topic.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<kafka.consumer.KafkaStream<byte[],byte[]>></code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreamsByFilter(kafka.consumer.TopicFilter)">createMessageStreamsByFilter</a></strong>(kafka.consumer.TopicFilter topicFilter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<kafka.consumer.KafkaStream<byte[],byte[]>></code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreamsByFilter(kafka.consumer.TopicFilter,%20int)">createMessageStreamsByFilter</a></strong>(kafka.consumer.TopicFilter topicFilter, + int numStreams)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><K,V> java.util.List<kafka.consumer.KafkaStream<K,V>></code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#createMessageStreamsByFilter(kafka.consumer.TopicFilter,%20int,%20kafka.serializer.Decoder,%20kafka.serializer.Decoder)">createMessageStreamsByFilter</a></strong>(kafka.consumer.TopicFilter topicFilter, + int numStreams, + kafka.serializer.Decoder<K> keyDecoder, + kafka.serializer.Decoder<V> valueDecoder)</code> +<div class="block">Create a list of MessageAndTopicStreams containing messages of type T.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#setConsumerRebalanceListener(kafka.javaapi.consumer.ConsumerRebalanceListener)">setConsumerRebalanceListener</a></strong>(<a href="../../../kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer">ConsumerRebalanceListener</a> listener)</code> +<div class="block">Wire in a consumer rebalance listener to be executed when consumer rebalance occurs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Shut down the connector</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createMessageStreams(java.util.Map, kafka.serializer.Decoder, kafka.serializer.Decoder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMessageStreams</h4> +<pre><K,V> java.util.Map<java.lang.String,java.util.List<kafka.consumer.KafkaStream<K,V>>> createMessageStreams(java.util.Map<java.lang.String,java.lang.Integer> topicCountMap, + kafka.serializer.Decoder<K> keyDecoder, + kafka.serializer.Decoder<V> valueDecoder)</pre> +<div class="block">Create a list of MessageStreams of type T for each topic.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topicCountMap</code> - a map of (topic, #streams) pair</dd><dd><code>keyDecoder</code> - a decoder that decodes the message key</dd><dd><code>valueDecoder</code> - a decoder that decodes the message itself</dd> +<dt><span class="strong">Returns:</span></dt><dd>a map of (topic, list of KafkaStream) pairs. + The number of items in the list is #streams. Each stream supports + an iterator over message/metadata pairs.</dd></dl> +</li> +</ul> +<a name="createMessageStreams(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMessageStreams</h4> +<pre>java.util.Map<java.lang.String,java.util.List<kafka.consumer.KafkaStream<byte[],byte[]>>> createMessageStreams(java.util.Map<java.lang.String,java.lang.Integer> topicCountMap)</pre> +</li> +</ul> +<a name="createMessageStreamsByFilter(kafka.consumer.TopicFilter, int, kafka.serializer.Decoder, kafka.serializer.Decoder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMessageStreamsByFilter</h4> +<pre><K,V> java.util.List<kafka.consumer.KafkaStream<K,V>> createMessageStreamsByFilter(kafka.consumer.TopicFilter topicFilter, + int numStreams, + kafka.serializer.Decoder<K> keyDecoder, + kafka.serializer.Decoder<V> valueDecoder)</pre> +<div class="block">Create a list of MessageAndTopicStreams containing messages of type T.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topicFilter</code> - a TopicFilter that specifies which topics to + subscribe to (encapsulates a whitelist or a blacklist).</dd><dd><code>numStreams</code> - the number of message streams to return.</dd><dd><code>keyDecoder</code> - a decoder that decodes the message key</dd><dd><code>valueDecoder</code> - a decoder that decodes the message itself</dd> +<dt><span class="strong">Returns:</span></dt><dd>a list of KafkaStream. Each stream supports an + iterator over its MessageAndMetadata elements.</dd></dl> +</li> +</ul> +<a name="createMessageStreamsByFilter(kafka.consumer.TopicFilter, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMessageStreamsByFilter</h4> +<pre>java.util.List<kafka.consumer.KafkaStream<byte[],byte[]>> createMessageStreamsByFilter(kafka.consumer.TopicFilter topicFilter, + int numStreams)</pre> +</li> +</ul> +<a name="createMessageStreamsByFilter(kafka.consumer.TopicFilter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMessageStreamsByFilter</h4> +<pre>java.util.List<kafka.consumer.KafkaStream<byte[],byte[]>> createMessageStreamsByFilter(kafka.consumer.TopicFilter topicFilter)</pre> +</li> +</ul> +<a name="commitOffsets()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitOffsets</h4> +<pre>void commitOffsets()</pre> +<div class="block">Commit the offsets of all broker partitions connected by this connector.</div> +</li> +</ul> +<a name="commitOffsets(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitOffsets</h4> +<pre>void commitOffsets(boolean retryOnFailure)</pre> +</li> +</ul> +<a name="commitOffsets(java.util.Map, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitOffsets</h4> +<pre>void commitOffsets(java.util.Map<kafka.common.TopicAndPartition,kafka.common.OffsetAndMetadata> offsetsToCommit, + boolean retryOnFailure)</pre> +<div class="block">Commit offsets using the provided offsets map</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsetsToCommit</code> - a map containing the offset to commit for each partition.</dd><dd><code>retryOnFailure</code> - enable retries on the offset commit if it fails.</dd></dl> +</li> +</ul> +<a name="setConsumerRebalanceListener(kafka.javaapi.consumer.ConsumerRebalanceListener)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConsumerRebalanceListener</h4> +<pre>void setConsumerRebalanceListener(<a href="../../../kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer">ConsumerRebalanceListener</a> listener)</pre> +<div class="block">Wire in a consumer rebalance listener to be executed when consumer rebalance occurs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The consumer rebalance listener to wire in</dd></dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>void shutdown()</pre> +<div class="block">Shut down the connector</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../kafka/javaapi/consumer/ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?kafka/javaapi/consumer/ConsumerConnector.html" target="_top">Frames</a></li> +<li><a href="ConsumerConnector.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/kafka/javaapi/consumer/ConsumerRebalanceListener.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/kafka/javaapi/consumer/ConsumerRebalanceListener.html b/0100/javadoc/kafka/javaapi/consumer/ConsumerRebalanceListener.html new file mode 100644 index 0000000..3117924 --- /dev/null +++ b/0100/javadoc/kafka/javaapi/consumer/ConsumerRebalanceListener.html @@ -0,0 +1,236 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>ConsumerRebalanceListener (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConsumerRebalanceListener (core 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?kafka/javaapi/consumer/ConsumerRebalanceListener.html" target="_top">Frames</a></li> +<li><a href="ConsumerRebalanceListener.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">kafka.javaapi.consumer</div> +<h2 title="Interface ConsumerRebalanceListener" class="title">Interface ConsumerRebalanceListener</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ConsumerRebalanceListener</span></pre> +<div class="block">This listener is used for execution of tasks defined by user when a consumer rebalance + occurs in <code>ZookeeperConsumerConnector</code></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerRebalanceListener.html#beforeReleasingPartitions(java.util.Map)">beforeReleasingPartitions</a></strong>(java.util.Map<java.lang.String,java.util.Set<java.lang.Integer>> partitionOwnership)</code> +<div class="block">This method is called after all the fetcher threads are stopped but before the + ownership of partitions are released.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../kafka/javaapi/consumer/ConsumerRebalanceListener.html#beforeStartingFetchers(java.lang.String,%20java.util.Map)">beforeStartingFetchers</a></strong>(java.lang.String consumerId, + java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,kafka.consumer.ConsumerThreadId>> globalPartitionAssignment)</code> +<div class="block">This method is called after the new partition assignment is finished but before fetcher + threads start.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="beforeReleasingPartitions(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeReleasingPartitions</h4> +<pre>void beforeReleasingPartitions(java.util.Map<java.lang.String,java.util.Set<java.lang.Integer>> partitionOwnership)</pre> +<div class="block">This method is called after all the fetcher threads are stopped but before the + ownership of partitions are released. Depending on whether auto offset commit is + enabled or not, offsets may or may not have been committed. + This listener is initially added to prevent duplicate messages on consumer rebalance + in mirror maker, where offset auto commit is disabled to prevent data loss. It could + also be used in more general cases.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitionOwnership</code> - The partition this consumer currently owns.</dd></dl> +</li> +</ul> +<a name="beforeStartingFetchers(java.lang.String, java.util.Map)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>beforeStartingFetchers</h4> +<pre>void beforeStartingFetchers(java.lang.String consumerId, + java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,kafka.consumer.ConsumerThreadId>> globalPartitionAssignment)</pre> +<div class="block">This method is called after the new partition assignment is finished but before fetcher + threads start. A map of new global partition assignment is passed in as parameter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>consumerId</code> - The consumer Id string of the consumer invoking this callback.</dd><dd><code>globalPartitionAssignment</code> - A Map[topic, Map[Partition, ConsumerThreadId]]. It is the global partition + assignment of this consumer group.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../kafka/javaapi/consumer/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../kafka/javaapi/consumer/ConsumerConnector.html" title="interface in kafka.javaapi.consumer"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?kafka/javaapi/consumer/ConsumerRebalanceListener.html" target="_top">Frames</a></li> +<li><a href="ConsumerRebalanceListener.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/46fccbe1/0100/javadoc/kafka/javaapi/consumer/package-frame.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/kafka/javaapi/consumer/package-frame.html b/0100/javadoc/kafka/javaapi/consumer/package-frame.html new file mode 100644 index 0000000..232a00d --- /dev/null +++ b/0100/javadoc/kafka/javaapi/consumer/package-frame.html @@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 28 13:06:16 PDT 2016 --> +<title>kafka.javaapi.consumer (core 0.10.0.0 API)</title> +<meta name="date" content="2016-03-28"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../kafka/javaapi/consumer/package-summary.html" target="classFrame">kafka.javaapi.consumer</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="ConsumerConnector.html" title="interface in kafka.javaapi.consumer" target="classFrame"><i>ConsumerConnector</i></a></li> +<li><a href="ConsumerRebalanceListener.html" title="interface in kafka.javaapi.consumer" target="classFrame"><i>ConsumerRebalanceListener</i></a></li> +</ul> +</div> +</body> +</html>
