A B C D E F G H I K L M N O P R S T V W

A

ack(Object) - Method in class org.apache.heron.kafka.spout.KafkaSpout

activate() - Method in class org.apache.heron.kafka.spout.KafkaSpout

addToAckMsgs(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

addToEmitMsgs(long) - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

apply(ConsumerRecord<K, V>) - Method in class org.apache.heron.kafka.spout.ByTopicRecordTranslator

apply(ConsumerRecord<K, V>) - Method in class org.apache.heron.kafka.spout.DefaultRecordTranslator

apply(V) - Method in interface org.apache.heron.kafka.spout.Func

apply(ConsumerRecord<K, V>) - Method in interface org.apache.heron.kafka.spout.RecordTranslator

Translate the ConsumerRecord into a list of objects that can be emitted.

apply(ConsumerRecord<K, V>) - Method in class org.apache.heron.kafka.spout.SimpleRecordTranslator

assignPartitions(Consumer<K, V>, Set<TopicPartition>, ConsumerRebalanceListener) - Method in class org.apache.heron.kafka.spout.subscription.TopicAssigner

Assign partitions to the KafkaConsumer.

B

BOLT_KEY - Static variable in class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

BOLT_MESSAGE - Static variable in class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

boltKeyField - Variable in class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

boltMessageField - Variable in class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

build() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

build() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Builder(String, String...) - Constructor for class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Builder(String, Set<String>) - Constructor for class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Builder(String, Pattern) - Constructor for class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Builder(String, TopicFilter, ManualPartitioner) - Constructor for class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Create a KafkaSpoutConfig builder with default property values and no key/value deserializers.

builder(String, String...) - Static method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

Factory method that creates a Builder with String key/value deserializers.

builder(String, Set<String>) - Static method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

Factory method that creates a Builder with String key/value deserializers.

builder(String, Pattern) - Static method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

Factory method that creates a Builder with String key/value deserializers.

Builder(String, String...) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Builder(String, Set<String>) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Builder(String, Pattern) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Builder(String, TopicFilter, ManualPartitioner) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Create a KafkaSpoutConfig builder with default property values and no key/value deserializers.

ByTopicRecordTranslator<K,V> - Class in org.apache.heron.kafka.spout

Based off of a given Kafka topic a ConsumerRecord came from it will be translated to a Storm tuple and emitted to a given stream.

ByTopicRecordTranslator(Func<ConsumerRecord<K, V>, List<Object>>, Fields, String) - Constructor for class org.apache.heron.kafka.spout.ByTopicRecordTranslator

Create a simple record translator that will use func to extract the fields of the tuple, named by fields, and emit them to stream.

ByTopicRecordTranslator(Func<ConsumerRecord<K, V>, List<Object>>, Fields) - Constructor for class org.apache.heron.kafka.spout.ByTopicRecordTranslator

Create a simple record translator that will use func to extract the fields of the tuple, named by fields, and emit them to the default stream.

ByTopicRecordTranslator(RecordTranslator<K, V>) - Constructor for class org.apache.heron.kafka.spout.ByTopicRecordTranslator

Create a record translator with the given default translator.

C

cleanup() - Method in class org.apache.heron.kafka.bolt.KafkaBolt

close() - Method in class org.apache.heron.kafka.spout.KafkaSpout

collector - Variable in class org.apache.heron.kafka.spout.KafkaSpout

commit(OffsetAndMetadata) - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

Marks an offset as committed.

CommitMetadata - Class in org.apache.heron.kafka.spout.internal

Object representing metadata committed to Kafka.

CommitMetadata(String, int, String) - Constructor for class org.apache.heron.kafka.spout.internal.CommitMetadata

Kafka metadata.

CommitMetadataManager - Class in org.apache.heron.kafka.spout.internal

Generates and reads commit metadata.

CommitMetadataManager(TopologyContext, KafkaSpoutConfig.ProcessingGuarantee) - Constructor for class org.apache.heron.kafka.spout.internal.CommitMetadataManager

Create a manager with the given context.

CommonKafkaSpoutConfig<K,V> - Class in org.apache.heron.kafka.spout.internal

CommonKafkaSpoutConfig(CommonKafkaSpoutConfig.Builder<K, V, ?>) - Constructor for class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

Creates a new CommonKafkaSpoutConfig using a Builder.

CommonKafkaSpoutConfig.Builder<K,V,T extends CommonKafkaSpoutConfig.Builder<K,V,T>> - Class in org.apache.heron.kafka.spout.internal

compare(TopicPartition, TopicPartition) - Method in class org.apache.heron.kafka.spout.TopicPartitionComparator

ConsumerFactory<K,V> - Interface in org.apache.heron.kafka.spout.internal

This is here to enable testing.

ConsumerFactoryDefault<K,V> - Class in org.apache.heron.kafka.spout.internal

ConsumerFactoryDefault() - Constructor for class org.apache.heron.kafka.spout.internal.ConsumerFactoryDefault

contains(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

createConsumer(Map<String, Object>) - Method in interface org.apache.heron.kafka.spout.internal.ConsumerFactory

createConsumer(Map<String, Object>) - Method in class org.apache.heron.kafka.spout.internal.ConsumerFactoryDefault

D

deactivate() - Method in class org.apache.heron.kafka.spout.KafkaSpout

declareOutputFields(OutputFieldsDeclarer) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

declareOutputFields(OutputFieldsDeclarer) - Method in class org.apache.heron.kafka.spout.KafkaSpout

DEFAULT_FIRST_POLL_OFFSET_STRATEGY - Static variable in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

DEFAULT_MAX_RETRIES - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DEFAULT_MAX_UNCOMMITTED_OFFSETS - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DEFAULT_OFFSET_COMMIT_PERIOD_MS - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DEFAULT_PARTITION_REFRESH_PERIOD_MS - Static variable in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

DEFAULT_POLL_TIMEOUT_MS - Static variable in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

DEFAULT_PROCESSING_GUARANTEE - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DEFAULT_RETRY_SERVICE - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DEFAULT_START_TS - Static variable in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

DEFAULT_STREAM - Static variable in interface org.apache.heron.kafka.spout.RecordTranslator

DEFAULT_TUPLE_LISTENER - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

DefaultRecordTranslator<K,V> - Class in org.apache.heron.kafka.spout

DefaultRecordTranslator() - Constructor for class org.apache.heron.kafka.spout.DefaultRecordTranslator

DefaultTopicSelector - Class in org.apache.heron.kafka.bolt.selector

DefaultTopicSelector(String) - Constructor for class org.apache.heron.kafka.bolt.selector.DefaultTopicSelector

delay() - Method in class org.apache.heron.kafka.spout.internal.Timer

E

earliestRetriableOffsets() - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

earliestRetriableOffsets() - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Gets the earliest retriable offsets.

EmptyKafkaTupleListener - Class in org.apache.heron.kafka.spout

EmptyKafkaTupleListener() - Constructor for class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

equals(Object) - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

F

fail(Object) - Method in class org.apache.heron.kafka.spout.KafkaSpout

FieldIndexTopicSelector - Class in org.apache.heron.kafka.bolt.selector

Uses field with a given index to select the topic name from a tuple .

FieldIndexTopicSelector(int, String) - Constructor for class org.apache.heron.kafka.bolt.selector.FieldIndexTopicSelector

Creates a new FieldIndexTopicSelector.

FieldNameBasedTupleToKafkaMapper<K,V> - Class in org.apache.heron.kafka.bolt.mapper

FieldNameBasedTupleToKafkaMapper() - Constructor for class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

FieldNameBasedTupleToKafkaMapper(String, String) - Constructor for class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

FieldNameTopicSelector - Class in org.apache.heron.kafka.bolt.selector

Uses field name to select topic name from tuple .

FieldNameTopicSelector(String, String) - Constructor for class org.apache.heron.kafka.bolt.selector.FieldNameTopicSelector

FIELDS - Static variable in class org.apache.heron.kafka.spout.DefaultRecordTranslator

findNextCommitOffset(String) - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

An offset can only be committed when all emitted records with lower offset have been acked.

FirstPollOffsetStrategy - Enum in org.apache.heron.kafka.spout

Defines how the spout seeks the offset to be used in the first poll to Kafka upon topology deployment.

forTopic(String, Func<ConsumerRecord<K, V>, List<Object>>, Fields) - Method in class org.apache.heron.kafka.spout.ByTopicRecordTranslator

Configure a translator for a given topic with tuples to be emitted to the default stream.

forTopic(String, Func<ConsumerRecord<K, V>, List<Object>>, Fields, String) - Method in class org.apache.heron.kafka.spout.ByTopicRecordTranslator

Configure a translator for a given topic.

forTopic(String, RecordTranslator<K, V>) - Method in class org.apache.heron.kafka.spout.ByTopicRecordTranslator

Configure a translator for a given kafka topic.

Func<V,R> - Interface in org.apache.heron.kafka.spout

A simple interface to allow compatibility with non java 8 code bases.

G

getAllSubscribedPartitions(Consumer<?, ?>) - Method in class org.apache.heron.kafka.spout.subscription.NamedTopicFilter

getAllSubscribedPartitions(Consumer<?, ?>) - Method in class org.apache.heron.kafka.spout.subscription.PatternTopicFilter

getAllSubscribedPartitions(Consumer<?, ?>) - Method in interface org.apache.heron.kafka.spout.subscription.TopicFilter

Get the Kafka TopicPartitions subscribed to by this set of spouts.

getCommitMetadata() - Method in class org.apache.heron.kafka.spout.internal.CommitMetadataManager

getCommittedOffset() - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

getComponentConfiguration() - Method in class org.apache.heron.kafka.spout.KafkaSpout

getConsumerGroupId() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getFieldsFor(String) - Method in class org.apache.heron.kafka.spout.ByTopicRecordTranslator

getFieldsFor(String) - Method in class org.apache.heron.kafka.spout.DefaultRecordTranslator

getFieldsFor(String) - Method in interface org.apache.heron.kafka.spout.RecordTranslator

Get the fields associated with a stream.

getFieldsFor(String) - Method in class org.apache.heron.kafka.spout.SimpleRecordTranslator

getFirstPollOffsetStrategy() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getKafkaProps() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

getKafkaProps() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

Gets the properties that will be passed to the KafkaConsumer.

getKeyFromTuple(Tuple) - Method in class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

getKeyFromTuple(Tuple) - Method in interface org.apache.heron.kafka.bolt.mapper.TupleToKafkaMapper

getLatestEmittedOffset() - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

getMaxUncommittedOffsets() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getMessageFromTuple(Tuple) - Method in class org.apache.heron.kafka.bolt.mapper.FieldNameBasedTupleToKafkaMapper

getMessageFromTuple(Tuple) - Method in interface org.apache.heron.kafka.bolt.mapper.TupleToKafkaMapper

getMessageId(TopicPartition, long) - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

getMessageId(TopicPartition, long) - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Gets the KafkaSpoutMessageId for the record on the given topic partition and offset.

getMetricsTimeBucketSizeInSecs() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getNthUncommittedOffsetAfterCommittedOffset(int) - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

Gets the offset of the nth emitted message after the committed offset.

getNumUncommittedOffsets() - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

getOffsetsCommitPeriodMs() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getPartitionRefreshPeriodMs() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getPartitionsForThisTask(List<TopicPartition>, TopologyContext) - Method in interface org.apache.heron.kafka.spout.subscription.ManualPartitioner

Filter the list of all partitions handled by this set of spouts to get only the partitions assigned to this task.

getPartitionsForThisTask(List<TopicPartition>, TopologyContext) - Method in class org.apache.heron.kafka.spout.subscription.RoundRobinManualPartitioner

getPollTimeoutMs() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getProcessingGuarantee() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getRetryService() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getStartTimeStamp() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getStream() - Method in class org.apache.heron.kafka.spout.KafkaTuple

getTaskId() - Method in class org.apache.heron.kafka.spout.internal.CommitMetadata

getThreadName() - Method in class org.apache.heron.kafka.spout.internal.CommitMetadata

getTimeUnit() - Method in class org.apache.heron.kafka.spout.internal.Timer

getTopic(Tuple) - Method in class org.apache.heron.kafka.bolt.selector.DefaultTopicSelector

getTopic(Tuple) - Method in class org.apache.heron.kafka.bolt.selector.FieldIndexTopicSelector

getTopic(Tuple) - Method in class org.apache.heron.kafka.bolt.selector.FieldNameTopicSelector

getTopic(Tuple) - Method in interface org.apache.heron.kafka.bolt.selector.KafkaTopicSelector

getTopicFilter() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getTopicPartition() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

getTopicPartitioner() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getTopicsPattern() - Method in class org.apache.heron.kafka.spout.subscription.PatternTopicFilter

getTopicsString() - Method in class org.apache.heron.kafka.spout.subscription.NamedTopicFilter

getTopicsString() - Method in class org.apache.heron.kafka.spout.subscription.PatternTopicFilter

getTopicsString() - Method in interface org.apache.heron.kafka.spout.subscription.TopicFilter

Get the topics string.

getTopologyId() - Method in class org.apache.heron.kafka.spout.internal.CommitMetadata

getTranslator() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

getTupleListener() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

getValueAndReset() - Method in class org.apache.heron.kafka.spout.metrics.KafkaMetricDecorator

getValueAndReset() - Method in class org.apache.heron.kafka.spout.metrics.KafkaOffsetMetric

H

hasCommitted() - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

Checks if this OffsetManager has committed to Kafka.

hashCode() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

I

incrementNumFails() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

INSTANCE - Static variable in class org.apache.heron.kafka.spout.TopicPartitionComparator

isEmitNullTuples() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

isExpiredResetOnTrue() - Method in class org.apache.heron.kafka.spout.internal.Timer

Checks if a call to this method occurs later than period since the timer was initiated or reset.

isNullTuple() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

isOffsetCommittedByThisTopology(TopicPartition, OffsetAndMetadata, Map<TopicPartition, OffsetManager>) - Method in class org.apache.heron.kafka.spout.internal.CommitMetadataManager

Checks if OffsetAndMetadata was committed by a KafkaSpout instance in this topology.

isReady(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

isReady(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Checks if a specific failed KafkaSpoutMessageId is ready to be retried, i.e is scheduled and has retry time that is less than current time.

isScheduled(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

isScheduled(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Checks if a specific failed KafkaSpoutMessageId is scheduled to be retried.

isTupleTrackingEnforced() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

K

KafkaBolt<K,V> - Class in org.apache.heron.kafka.bolt

Bolt implementation that can send Tuple data to Kafka.

KafkaBolt() - Constructor for class org.apache.heron.kafka.bolt.KafkaBolt

KafkaMetricDecorator<M extends org.apache.kafka.common.Metric> - Class in org.apache.heron.kafka.spout.metrics

a decorator to convert a Kafka Metric to a Heron Metric so that Kafka metrics can be exposed via Heron Metrics Manager

KafkaMetricDecorator(M) - Constructor for class org.apache.heron.kafka.spout.metrics.KafkaMetricDecorator

KafkaOffsetMetric<K,V> - Class in org.apache.heron.kafka.spout.metrics

This class is used compute the partition and topic level offset metrics.

KafkaOffsetMetric(Supplier<Map<TopicPartition, OffsetManager>>, Supplier<Consumer<K, V>>) - Constructor for class org.apache.heron.kafka.spout.metrics.KafkaOffsetMetric

KafkaSpout<K,V> - Class in org.apache.heron.kafka.spout

KafkaSpout(KafkaSpoutConfig<K, V>) - Constructor for class org.apache.heron.kafka.spout.KafkaSpout

KafkaSpoutConfig<K,V> - Class in org.apache.heron.kafka.spout

KafkaSpoutConfig defines the required configuration to connect a consumer to a consumer group, as well as the subscribing topics.

KafkaSpoutConfig(KafkaSpoutConfig.Builder<K, V>) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutConfig

Creates a new KafkaSpoutConfig using a Builder.

KafkaSpoutConfig.Builder<K,V> - Class in org.apache.heron.kafka.spout

KafkaSpoutConfig.ProcessingGuarantee - Enum in org.apache.heron.kafka.spout

This enum controls when the tuple with the ConsumerRecord for an offset is marked as processed, i.e.

KafkaSpoutMessageId - Class in org.apache.heron.kafka.spout

KafkaSpoutMessageId(ConsumerRecord<?, ?>) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutMessageId

KafkaSpoutMessageId(ConsumerRecord<?, ?>, boolean) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutMessageId

KafkaSpoutMessageId(TopicPartition, long) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutMessageId

KafkaSpoutMessageId(TopicPartition, long, boolean) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutMessageId

Creates a new KafkaSpoutMessageId.

KafkaSpoutRetryExponentialBackoff - Class in org.apache.heron.kafka.spout

Implementation of KafkaSpoutRetryService using the exponential backoff formula.

KafkaSpoutRetryExponentialBackoff(KafkaSpoutRetryExponentialBackoff.TimeInterval, KafkaSpoutRetryExponentialBackoff.TimeInterval, int, KafkaSpoutRetryExponentialBackoff.TimeInterval) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

The time stamp of the next retry is scheduled according to the exponential backoff formula (geometric progression): nextRetry = failCount == 1 ? currentTime + initialDelay : currentTime + delayPeriod^(failCount-1), where failCount = 1, 2, 3, … nextRetry = Min(nextRetry, currentTime + maxDelay).

KafkaSpoutRetryExponentialBackoff.TimeInterval - Class in org.apache.heron.kafka.spout

KafkaSpoutRetryService - Interface in org.apache.heron.kafka.spout

Represents the logic that manages the retrial of failed tuples.

KafkaTopicSelector - Interface in org.apache.heron.kafka.bolt.selector

KafkaTuple - Class in org.apache.heron.kafka.spout

A list of Values in a tuple that can be routed to a given stream.

KafkaTuple() - Constructor for class org.apache.heron.kafka.spout.KafkaTuple

KafkaTuple(Object...) - Constructor for class org.apache.heron.kafka.spout.KafkaTuple

KafkaTupleListener - Interface in org.apache.heron.kafka.spout

The KafkaTupleListener handles state changes of a kafka tuple inside a KafkaSpout.

L

lengthNanos() - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

LOG - Static variable in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

LOG - Static variable in class org.apache.heron.kafka.spout.KafkaSpoutConfig

M

ManualPartitioner - Interface in org.apache.heron.kafka.spout.subscription

A function used to assign partitions to this spout.

microSeconds(long) - Static method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

milliSeconds(long) - Static method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

mkProducer(Properties) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

Intended to be overridden for tests.

N

NamedTopicFilter - Class in org.apache.heron.kafka.spout.subscription

Filter that returns all partitions for the specified topics.

NamedTopicFilter(Set<String>) - Constructor for class org.apache.heron.kafka.spout.subscription.NamedTopicFilter

Create filter based on a set of topic names.

NamedTopicFilter(String...) - Constructor for class org.apache.heron.kafka.spout.subscription.NamedTopicFilter

Convenience constructor.

nextTuple() - Method in class org.apache.heron.kafka.spout.KafkaSpout

numFails() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

O

offset() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

OffsetManager - Class in org.apache.heron.kafka.spout.internal

Manages acked and committed offsets for a TopicPartition.

OffsetManager(TopicPartition, long) - Constructor for class org.apache.heron.kafka.spout.internal.OffsetManager

Creates a new OffsetManager.

onAck(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

onAck(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaTupleListener

Called when a tuple is acked.

onEmit(List<Object>, KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

onEmit(List<Object>, KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaTupleListener

Called when the tuple is emitted and auto commit is disabled.

onMaxRetryReached(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

onMaxRetryReached(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaTupleListener

Called when the maximum number of retries have been reached.

onPartitionsReassigned(Collection<TopicPartition>) - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

onPartitionsReassigned(Collection<TopicPartition>) - Method in interface org.apache.heron.kafka.spout.KafkaTupleListener

Called when kafka partitions are rebalanced.

onRetry(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

onRetry(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaTupleListener

Called when the Kafka spout sets a record for retry.

open(Map<String, Object>, TopologyContext) - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

open(Map<String, Object>, TopologyContext, SpoutOutputCollector) - Method in class org.apache.heron.kafka.spout.KafkaSpout

open(Map<String, Object>, TopologyContext) - Method in interface org.apache.heron.kafka.spout.KafkaTupleListener

Called during the initialization of the kafka spout.

org.apache.heron.kafka.bolt - package org.apache.heron.kafka.bolt

org.apache.heron.kafka.bolt.mapper - package org.apache.heron.kafka.bolt.mapper

org.apache.heron.kafka.bolt.selector - package org.apache.heron.kafka.bolt.selector

org.apache.heron.kafka.spout - package org.apache.heron.kafka.spout

org.apache.heron.kafka.spout.internal - package org.apache.heron.kafka.spout.internal

org.apache.heron.kafka.spout.metrics - package org.apache.heron.kafka.spout.metrics

org.apache.heron.kafka.spout.subscription - package org.apache.heron.kafka.spout.subscription

P

partition() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

PatternTopicFilter - Class in org.apache.heron.kafka.spout.subscription

Filter that returns all partitions for topics matching the given Pattern.

PatternTopicFilter(Pattern) - Constructor for class org.apache.heron.kafka.spout.subscription.PatternTopicFilter

Creates filter based on a Pattern.

period() - Method in class org.apache.heron.kafka.spout.internal.Timer

PreparableCallback - Interface in org.apache.heron.kafka.bolt

Serializable callback for use with the KafkaProducer on KafkaBolt.

prepare(Map<String, Object>, TopologyContext, OutputCollector) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

prepare(Map<String, Object>, TopologyContext) - Method in interface org.apache.heron.kafka.bolt.PreparableCallback

process(Tuple) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

R

readyMessageCount() - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

readyMessageCount() - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Get the number of messages ready for retry.

RecordTranslator<K,V> - Interface in org.apache.heron.kafka.spout

Translate a ConsumerRecord to a tuple.

remove(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

remove(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Removes a message from the list of messages scheduled for retrial.

retainAll(Collection<TopicPartition>) - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

retainAll(Collection<TopicPartition>) - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Retains all the messages whose TopicPartition belongs to the specified Collection<TopicPartition>.

RoundRobinManualPartitioner - Class in org.apache.heron.kafka.spout.subscription

Assign partitions in a round robin fashion for all spouts, not just the ones that are alive.

RoundRobinManualPartitioner() - Constructor for class org.apache.heron.kafka.spout.subscription.RoundRobinManualPartitioner

routedTo(String) - Method in class org.apache.heron.kafka.spout.KafkaTuple

Sets the target stream of this Tuple.

S

schedule(KafkaSpoutMessageId) - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

schedule(KafkaSpoutMessageId) - Method in interface org.apache.heron.kafka.spout.KafkaSpoutRetryService

Schedules this KafkaSpoutMessageId if not yet scheduled, or updates retry time if it has already been scheduled.

seconds(long) - Static method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

setAsync(boolean) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

If set to true(the default) the bolt will not wait for the message to be fully sent to Kafka before getting another tuple to send.

setEmitNullTuples(boolean) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Specifies if the spout should emit null tuples to the component downstream, or rather not emit and directly ack them.

setFireAndForget(boolean) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

If set to true the bolt will assume that sending a message to kafka will succeed and will ack the tuple as soon as it has handed the message off to the producer API if false (the default) the message will be acked after it was successfully sent to kafka or failed if it was not successfully sent.

setFirstPollOffsetStrategy(FirstPollOffsetStrategy) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Sets the offset used by the Kafka spout in the first poll to Kafka broker upon process start.

setMaxUncommittedOffsets(int) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Defines the max number of polled offsets (records) that can be pending commit, before another poll can take place.

setMetricsTimeBucketSizeInSecs(int) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

The time period that metrics data in bucketed into.

setNullTuple(boolean) - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

setOffsetCommitPeriodMs(long) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Specifies the period, in milliseconds, the offset commit task is periodically called.

setPartitionRefreshPeriodMs(long) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Sets partition refresh period in milliseconds.

setPollTimeoutMs(long) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Specifies the time, in milliseconds, spent waiting in poll if data is not available.

setProcessingGuarantee(KafkaSpoutConfig.ProcessingGuarantee) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Specifies which processing guarantee the spout should offer.

setProp(String, Object) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Set a KafkaConsumer property.

setProp(Map<String, Object>) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Set multiple KafkaConsumer properties.

setProp(Properties) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Set multiple KafkaConsumer properties.

setRecordTranslator(RecordTranslator<K, V>) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

setRecordTranslator(Func<ConsumerRecord<K, V>, List<Object>>, Fields) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Configure a translator with tuples to be emitted on the default stream.

setRecordTranslator(Func<ConsumerRecord<K, V>, List<Object>>, Fields, String) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Configure a translator with tuples to be emitted to a given stream.

setRetry(KafkaSpoutRetryService) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Sets the retry service for the spout to use.

setStartTimeStamp(long) - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig.Builder

Specifies the startTimeStamp if the first poll strategy is TIMESTAMP or UNCOMMITTED_TIMESTAMP.

setTupleListener(KafkaTupleListener) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Sets the tuple listener for the spout to use.

setTupleTrackingEnforced(boolean) - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig.Builder

Specifies whether the spout should require Storm to track emitted tuples when using a KafkaSpoutConfig.ProcessingGuarantee other than KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE.

SimpleRecordTranslator<K,V> - Class in org.apache.heron.kafka.spout

SimpleRecordTranslator(Func<ConsumerRecord<K, V>, List<Object>>, Fields) - Constructor for class org.apache.heron.kafka.spout.SimpleRecordTranslator

SimpleRecordTranslator(Func<ConsumerRecord<K, V>, List<Object>>, Fields, String) - Constructor for class org.apache.heron.kafka.spout.SimpleRecordTranslator

Creates a SimpleRecordTranslator.

streams() - Method in class org.apache.heron.kafka.spout.ByTopicRecordTranslator

streams() - Method in interface org.apache.heron.kafka.spout.RecordTranslator

Get the list of streams this translator will handle.

streams() - Method in class org.apache.heron.kafka.spout.SimpleRecordTranslator

T

TimeInterval(long, TimeUnit) - Constructor for class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

Creates a new TimeInterval.

Timer - Class in org.apache.heron.kafka.spout.internal

Timer(long, long, TimeUnit) - Constructor for class org.apache.heron.kafka.spout.internal.Timer

Creates a class that mimics a single threaded timer that expires periodically.

TIMER_DELAY_MS - Static variable in class org.apache.heron.kafka.spout.KafkaSpout

timeUnit() - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

TOPIC - Static variable in class org.apache.heron.kafka.bolt.KafkaBolt

topic() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

TopicAssigner - Class in org.apache.heron.kafka.spout.subscription

Handles assigning partitions to the consumer and updating the rebalance listener.

TopicAssigner() - Constructor for class org.apache.heron.kafka.spout.subscription.TopicAssigner

TopicFilter - Interface in org.apache.heron.kafka.spout.subscription

TopicPartitionComparator - Class in org.apache.heron.kafka.spout

Singleton comparator of TopicPartitions.

toString() - Method in class org.apache.heron.kafka.bolt.KafkaBolt

toString() - Method in class org.apache.heron.kafka.spout.EmptyKafkaTupleListener

toString() - Method in class org.apache.heron.kafka.spout.internal.CommitMetadata

toString() - Method in class org.apache.heron.kafka.spout.internal.CommonKafkaSpoutConfig

toString() - Method in class org.apache.heron.kafka.spout.internal.OffsetManager

toString() - Method in class org.apache.heron.kafka.spout.KafkaSpout

toString() - Method in class org.apache.heron.kafka.spout.KafkaSpoutConfig

toString() - Method in class org.apache.heron.kafka.spout.KafkaSpoutMessageId

toString() - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff.TimeInterval

toString() - Method in class org.apache.heron.kafka.spout.KafkaSpoutRetryExponentialBackoff

TupleToKafkaMapper<K,V> - Interface in org.apache.heron.kafka.bolt.mapper

Interface defining a mapping from storm tuple to kafka key and message.

V

valueOf(String) - Static method in enum org.apache.heron.kafka.spout.FirstPollOffsetStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.heron.kafka.spout.KafkaSpoutConfig.ProcessingGuarantee

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.heron.kafka.spout.FirstPollOffsetStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.heron.kafka.spout.KafkaSpoutConfig.ProcessingGuarantee

Returns an array containing the constants of this enum type, in the order they are declared.

W

withProducerCallback(PreparableCallback) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

Sets a user defined callback for use with the KafkaProducer.

withProducerProperties(Properties) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

withTopicSelector(String) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

Set the messages to be published to a single topic.

withTopicSelector(KafkaTopicSelector) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

withTupleToKafkaMapper(TupleToKafkaMapper<K, V>) - Method in class org.apache.heron.kafka.bolt.KafkaBolt

A B C D E F G H I K L M N O P R S T V W