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

A

AccumulationMode - Enum in org.apache.samza.operators.windows

Specifies how a Window should process its previously emitted WindowPanes.

all() - Method in interface org.apache.samza.storage.kv.KeyValueStore

Returns an iterator for all entries in this key-value store.

any(Trigger<M>...) - Static method in class org.apache.samza.operators.triggers.Triggers

Creates a trigger that fires when any of the provided triggers fire.

AnyTrigger<M extends MessageEnvelope> - Class in org.apache.samza.operators.triggers

A Trigger fires as soon as any of its individual triggers has fired.

ApplicationStatus - Enum in org.apache.samza.job

Status of a StreamJob during and after its run.

apply(M) - Method in interface org.apache.samza.operators.functions.FilterFunction

Returns a boolean indicating whether this MessageEnvelope should be retained or filtered out.

apply(M) - Method in interface org.apache.samza.operators.functions.FlatMapFunction

Transforms the provided MessageEnvelope into a collection of 0 or more MessageEnvelopes.

apply(M, JM) - Method in interface org.apache.samza.operators.functions.JoinFunction

Join the provided MessageEnvelopes and produces the joined MessageEnvelope.

apply(M) - Method in interface org.apache.samza.operators.functions.MapFunction

Transforms the provided MessageEnvelope into another MessageEnvelope

apply(M, MessageCollector, TaskCoordinator) - Method in interface org.apache.samza.operators.functions.SinkFunction

Allows sending the provided MessageEnvelope to an output SystemStream using the provided MessageCollector.

AsyncStreamTask - Interface in org.apache.samza.task

An AsyncStreamTask is the basic class to support multithreading execution in Samza container.

AsyncStreamTaskFactory - Interface in org.apache.samza.task

Build AsyncStreamTask instances.

B

BaseMessageChooser - Class in org.apache.samza.system.chooser

An abstract MessageChooser that implements start/stop/register for choosers that don't use them.

BaseMessageChooser() - Constructor for class org.apache.samza.system.chooser.BaseMessageChooser

BLOCK_ON_OUTSTANDING_MESSAGES - Static variable in interface org.apache.samza.system.SystemConsumer

A constant that can be used in the poll method's timeout parameter to denote that the poll invocation should block until at least one message is available for one of the SystemStreamPartitions supplied, or until all SystemStreamPartitions supplied are at head (have no new messages available since the last poll invocation was made for each SystemStreamPartition).

BlockingEnvelopeMap - Class in org.apache.samza.util

BlockingEnvelopeMap is a helper class for SystemConsumer implementations.

BlockingEnvelopeMap() - Constructor for class org.apache.samza.util.BlockingEnvelopeMap

BlockingEnvelopeMap(MetricsRegistry) - Constructor for class org.apache.samza.util.BlockingEnvelopeMap

BlockingEnvelopeMap(MetricsRegistry, Clock) - Constructor for class org.apache.samza.util.BlockingEnvelopeMap

BlockingEnvelopeMap(MetricsRegistry, Clock, String, boolean) - Constructor for class org.apache.samza.util.BlockingEnvelopeMap

BlockingEnvelopeMap.BlockingEnvelopeMapMetrics - Class in org.apache.samza.util

BlockingEnvelopeMap.BufferGauge - Class in org.apache.samza.util

BlockingEnvelopeMap.BufferSizeGauge - Class in org.apache.samza.util

BlockingEnvelopeMapMetrics(String, MetricsRegistry) - Constructor for class org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics

BufferGauge(SystemStreamPartition, String) - Constructor for class org.apache.samza.util.BlockingEnvelopeMap.BufferGauge

BufferSizeGauge(SystemStreamPartition, String) - Constructor for class org.apache.samza.util.BlockingEnvelopeMap.BufferSizeGauge

build() - Method in class org.apache.samza.storage.StoreProperties.StorePropertiesBuilder

buildCommand() - Method in class org.apache.samza.job.CommandBuilder

buildEndOfStreamEnvelope(SystemStreamPartition) - Static method in class org.apache.samza.system.IncomingMessageEnvelope

Builds an end-of-stream envelope for an SSP.

buildEnvironment() - Method in class org.apache.samza.job.CommandBuilder

C

Checkpoint - Class in org.apache.samza.checkpoint

A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each.

Checkpoint(Map<SystemStreamPartition, String>) - Constructor for class org.apache.samza.checkpoint.Checkpoint

Constructs a new checkpoint based off a map of Samza stream offsets.

CheckpointListener - Interface in org.apache.samza.checkpoint

This interface should be implemented by SystemConsumers which want to be notified about checkpoint values of the most recent checkpoint.

CheckpointManager - Interface in org.apache.samza.checkpoint

CheckpointManagers read and write Checkpoint to some implementation-specific location.

CheckpointManagerFactory - Interface in org.apache.samza.checkpoint

Build a CheckpointManager.

choose() - Method in interface org.apache.samza.system.chooser.MessageChooser

The choose method is invoked when the SamzaContainer is ready to process a new message.

clear() - Method in class org.apache.samza.config.Config

clear() - Method in class org.apache.samza.metrics.Counter

Clock - Interface in org.apache.samza.util

Mockable interface for tracking time.

ClosableTask - Interface in org.apache.samza.task

A ClosableTask augments StreamTask, allowing the method implementer to specify code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics, clean or close resources, etc.

close() - Method in interface org.apache.samza.storage.kv.KeyValueIterator

close() - Method in interface org.apache.samza.storage.kv.KeyValueStore

Closes this key-value store, if applicable, relinquishing any underlying resources.

close() - Method in interface org.apache.samza.task.ClosableTask

CommandBuilder - Class in org.apache.samza.job

CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework, such as YARN or the LocalJobRunner.

CommandBuilder() - Constructor for class org.apache.samza.job.CommandBuilder

commandPath - Variable in class org.apache.samza.job.CommandBuilder

commit(TaskCoordinator.RequestScope) - Method in interface org.apache.samza.task.TaskCoordinator

Requests that Samza should write out a checkpoint, from which a task can restart after failure.

compareAndSet(T, T) - Method in class org.apache.samza.metrics.Gauge

compareTo(TaskName) - Method in class org.apache.samza.container.TaskName

compareTo(Offset) - Method in class org.apache.samza.operators.data.LongOffset

compareTo(Partition) - Method in class org.apache.samza.Partition

compareTo(SystemStreamPartition) - Method in class org.apache.samza.system.SystemStreamPartition

complete() - Method in interface org.apache.samza.metrics.MetricsValidator

Complete validation.

complete() - Method in interface org.apache.samza.task.TaskCallback

Invoke when the asynchronous process completed with success.

Config - Class in org.apache.samza.config

Store and retrieve named, typed values as configuration for classes implementing this interface.

Config() - Constructor for class org.apache.samza.config.Config

config - Variable in class org.apache.samza.container.SamzaContainerContext

config - Variable in class org.apache.samza.job.CommandBuilder

ConfigException - Exception in org.apache.samza.config

Specific SamzaExceptions thrown from Config

ConfigException(Throwable) - Constructor for exception org.apache.samza.config.ConfigException

ConfigException(String) - Constructor for exception org.apache.samza.config.ConfigException

ConfigException(String, Throwable) - Constructor for exception org.apache.samza.config.ConfigException

ConfigFactory - Interface in org.apache.samza.config

Build a Config

ConfigRewriter - Interface in org.apache.samza.config

A ConfigRewriter receives the job's config during job startup and may re-write it to provide new configs, remove existing configs or audit and verify the config is correct or permitted.

containsKey(Object) - Method in class org.apache.samza.config.MapConfig

containsValue(Object) - Method in class org.apache.samza.config.MapConfig

count(long) - Static method in class org.apache.samza.operators.triggers.Triggers

Creates a Trigger that fires when the number of MessageEnvelopes in the pane reaches the specified count.

Counter - Class in org.apache.samza.metrics

A counter is a Metric that represents a cumulative value.

Counter(String) - Constructor for class org.apache.samza.metrics.Counter

counter(Counter) - Method in class org.apache.samza.metrics.MetricsVisitor

CountTrigger<M extends MessageEnvelope> - Class in org.apache.samza.operators.triggers

A Trigger that fires when the number of messages in the WindowPane reaches the specified count.

createChangelogStream(String, int) - Method in interface org.apache.samza.system.SystemAdmin

An API to create a change log stream

createChangelogStream(String, int) - Method in class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

createCoordinatorStream(String) - Method in interface org.apache.samza.system.SystemAdmin

Create a stream for the job coordinator.

createCoordinatorStream(String) - Method in class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

createInstance() - Method in interface org.apache.samza.task.AsyncStreamTaskFactory

createInstance() - Method in interface org.apache.samza.task.StreamTaskFactory

currentTimeMillis() - Method in interface org.apache.samza.util.Clock

D

dec() - Method in class org.apache.samza.metrics.Counter

dec(long) - Method in class org.apache.samza.metrics.Counter

delete(K) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Deletes the mapping for the specified key from this key-value store (if such mapping exists).

deleteAll(List<K>) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Deletes the mappings for the specified keys from this key-value store (if such mappings exist).

deleteAll(KeyValueStore<K, V>, List<K>) - Static method in class org.apache.samza.storage.kv.KeyValueStore.Extension

Deletes the mappings for the specified keys from this key-value store (if such mappings exist).

Deserializer<T> - Interface in org.apache.samza.serializers

A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their original form.

DurationCharacteristic - Enum in org.apache.samza.operators.triggers

Indicates whether the associated time duration is in event time or processing time.

E

END_OF_STREAM_OFFSET - Static variable in class org.apache.samza.system.IncomingMessageEnvelope

EndOfStreamListenerTask - Interface in org.apache.samza.task

The EndOfStreamListenerTask augments StreamTask allowing the method implementor to specify code to be executed when the 'end-of-stream' is reached for all input SSPs.

Entry<K,V> - Class in org.apache.samza.storage.kv

A key and value.

Entry(K, V) - Constructor for class org.apache.samza.storage.kv.Entry

entrySet() - Method in class org.apache.samza.config.MapConfig

equals(Object) - Method in class org.apache.samza.checkpoint.Checkpoint

equals(Object) - Method in class org.apache.samza.config.MapConfig

equals(Object) - Method in class org.apache.samza.container.TaskName

equals(Object) - Method in class org.apache.samza.operators.data.LongOffset

equals(Object) - Method in class org.apache.samza.Partition

equals(Object) - Method in class org.apache.samza.system.IncomingMessageEnvelope

equals(Object) - Method in class org.apache.samza.system.OutgoingMessageEnvelope

equals(Object) - Method in class org.apache.samza.system.SystemStream

equals(Object) - Method in class org.apache.samza.system.SystemStreamMetadata

equals(Object) - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

equals(Object) - Method in class org.apache.samza.system.SystemStreamPartition

ExtendedSystemAdmin - Interface in org.apache.samza.system

Interface extends the more generic SystemAdmin interface TODO: Merge this interface method with SystemAdmin when we upgrade to JDK 1.8

F

failure(Throwable) - Method in interface org.apache.samza.task.TaskCallback

Invoke when the asynchronous process failed with an error.

fetchLimitByBytesEnabled - Variable in class org.apache.samza.util.BlockingEnvelopeMap

filter(FilterFunction<M>) - Method in interface org.apache.samza.operators.MessageStream

Applies the provided FilterFunction to MessageEnvelopes in this MessageStream and returns the transformed MessageStream.

filter(Set<SystemStreamPartition>, Config) - Method in interface org.apache.samza.system.SystemStreamPartitionMatcher

FilterFunction<M extends MessageEnvelope> - Interface in org.apache.samza.operators.functions

A function that specifies whether a MessageEnvelope should be retained for further processing or filtered out.

flatMap(FlatMapFunction<M, TM>) - Method in interface org.apache.samza.operators.MessageStream

Applies the provided 1:n FlatMapFunction to transform a MessageEnvelope in this MessageStream to n MessageEnvelopes in the transformed MessageStream

FlatMapFunction<M extends MessageEnvelope,OM extends MessageEnvelope> - Interface in org.apache.samza.operators.functions

A function that transforms a MessageEnvelope into a collection of 0 or more MessageEnvelopes, possibly of a different type.

flush() - Method in interface org.apache.samza.storage.kv.KeyValueStore

Flushes this key-value store, if applicable.

flush() - Method in interface org.apache.samza.storage.StorageEngine

Flush any cached messages

flush(String) - Method in interface org.apache.samza.system.SystemProducer

If the SystemProducer buffers messages before sending them to its underlying system, it should flush those messages and leave no messages remaining to be sent.

fromBytes(byte[]) - Method in interface org.apache.samza.serializers.Deserializer

Deserializes given serialized object from an array of bytes to its original form.

G

Gauge<T> - Class in org.apache.samza.metrics

A Gauge is a Metric that wraps some instance of T in a thread-safe reference and allows it to be set or retrieved.

Gauge(String, T) - Constructor for class org.apache.samza.metrics.Gauge

gauge(Gauge<T>) - Method in class org.apache.samza.metrics.MetricsVisitor

get(String, String) - Method in class org.apache.samza.config.Config

get(Object) - Method in class org.apache.samza.config.MapConfig

get(K) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Gets the value associated with the specified key.

getAdmin(String, Config) - Method in interface org.apache.samza.system.SystemFactory

getAll(KeyValueStore<K, V>, List<K>) - Static method in class org.apache.samza.storage.kv.KeyValueStore.Extension

Gets the values with which the specified keys are associated.

getAll(List<K>) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Gets the values with which the specified keys are associated.

getAverage() - Method in class org.apache.samza.metrics.Snapshot

Get the average of the values in the collection

getBoolean(String, boolean) - Method in class org.apache.samza.config.Config

getBoolean(String) - Method in class org.apache.samza.config.Config

getCharacteristic() - Method in class org.apache.samza.operators.triggers.TimeSinceFirstMessageTrigger

getCharacteristic() - Method in class org.apache.samza.operators.triggers.TimeSinceLastMessageTrigger

getCharacteristic() - Method in class org.apache.samza.operators.triggers.TimeTrigger

getCheckpointManager(Config, MetricsRegistry) - Method in interface org.apache.samza.checkpoint.CheckpointManagerFactory

getChooser(Config, MetricsRegistry) - Method in interface org.apache.samza.system.chooser.MessageChooserFactory

getClass(String) - Method in class org.apache.samza.config.Config

getConfig(URI) - Method in interface org.apache.samza.config.ConfigFactory

Build a specific Config.

getConsumer(String, Config, MetricsRegistry) - Method in interface org.apache.samza.system.SystemFactory

getCount() - Method in class org.apache.samza.metrics.Counter

getCount() - Method in class org.apache.samza.operators.triggers.CountTrigger

getCounterValues(String, String) - Method in interface org.apache.samza.metrics.MetricsAccessor

Get the values of a counter

getDate(String) - Method in class org.apache.samza.config.Config

getDate(String, String) - Method in class org.apache.samza.config.Config

getDate(String, SimpleDateFormat) - Method in class org.apache.samza.config.Config

getDate(String, Date) - Method in class org.apache.samza.config.Config

getDate(String, String, Date) - Method in class org.apache.samza.config.Config

getDate(String, SimpleDateFormat, Date) - Method in class org.apache.samza.config.Config

getDefaultTrigger() - Method in class org.apache.samza.operators.windows.internal.WindowInternal

getDouble(String, double) - Method in class org.apache.samza.config.Config

getDouble(String) - Method in class org.apache.samza.config.Config

getDuration() - Method in class org.apache.samza.operators.triggers.TimeSinceFirstMessageTrigger

getDuration() - Method in class org.apache.samza.operators.triggers.TimeSinceLastMessageTrigger

getDuration() - Method in class org.apache.samza.operators.triggers.TimeTrigger

getEarlyTrigger() - Method in class org.apache.samza.operators.windows.internal.WindowInternal

getEventTimeExtractor() - Method in class org.apache.samza.operators.windows.internal.WindowInternal

getFoldFunction() - Method in class org.apache.samza.operators.windows.internal.WindowInternal

getGaugeValues(String, String) - Method in interface org.apache.samza.metrics.MetricsAccessor

Get the values of a gauge

getGroup(String) - Method in interface org.apache.samza.metrics.ReadableMetricsRegistry

getGroups() - Method in interface org.apache.samza.metrics.ReadableMetricsRegistry

getInt(String, int) - Method in class org.apache.samza.config.Config

getInt(String) - Method in class org.apache.samza.config.Config

getJob(Config) - Method in interface org.apache.samza.job.StreamJobFactory

getKey() - Method in class org.apache.samza.operators.data.IncomingSystemMessageEnvelope

getKey() - Method in interface org.apache.samza.operators.data.MessageEnvelope

Get the key for this MessageEnvelope.

getKey() - Method in class org.apache.samza.operators.windows.WindowKey

getKey() - Method in class org.apache.samza.operators.windows.WindowPane

getKey() - Method in class org.apache.samza.storage.kv.Entry

getKey() - Method in class org.apache.samza.system.IncomingMessageEnvelope

getKey() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

getKeyExtractor() - Method in class org.apache.samza.operators.windows.internal.WindowInternal

getKeySerializerName() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

getLateTrigger() - Method in class org.apache.samza.operators.windows.internal.WindowInternal

getList(String, List<String>) - Method in class org.apache.samza.config.Config

getList(String) - Method in class org.apache.samza.config.Config

getLong(String, long) - Method in class org.apache.samza.config.Config

getLong(String) - Method in class org.apache.samza.config.Config

getMax() - Method in class org.apache.samza.metrics.Snapshot

Get the maximum value in the collection

getMaxOffset() - Static method in class org.apache.samza.operators.data.LongOffset

Helper method to get the maximum offset

getMessage() - Method in class org.apache.samza.operators.data.IncomingSystemMessageEnvelope

getMessage() - Method in interface org.apache.samza.operators.data.MessageEnvelope

Get the message in this MessageEnvelope.

getMessage() - Method in class org.apache.samza.operators.windows.WindowPane

getMessage() - Method in class org.apache.samza.system.IncomingMessageEnvelope

getMessage() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

getMessageSerializerName() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

getMessagesSizeInQueue(SystemStreamPartition) - Method in class org.apache.samza.util.BlockingEnvelopeMap

getMetricsRegistry() - Method in interface org.apache.samza.task.TaskContext

getMetricsReporter(String, String, Config) - Method in interface org.apache.samza.metrics.MetricsReporterFactory

getMin() - Method in class org.apache.samza.metrics.Snapshot

Get the minimum value in the collection

getMinOffset() - Static method in class org.apache.samza.operators.data.LongOffset

Helper method to get the minimum offset

getName() - Method in class org.apache.samza.metrics.Counter

getName() - Method in class org.apache.samza.metrics.Gauge

getName() - Method in class org.apache.samza.metrics.Timer

Get the name of the timer

getNewestOffset(SystemStreamPartition, Integer) - Method in interface org.apache.samza.system.ExtendedSystemAdmin

getNewestOffset() - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

getNewInstance(String) - Method in class org.apache.samza.config.Config

getNumMessagesInQueue(SystemStreamPartition) - Method in class org.apache.samza.util.BlockingEnvelopeMap

getOffset() - Method in class org.apache.samza.operators.data.IncomingSystemMessageEnvelope

getOffset() - Method in class org.apache.samza.system.IncomingMessageEnvelope

getOffset(SystemStreamMetadata.OffsetType) - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

getOffsets() - Method in class org.apache.samza.checkpoint.Checkpoint

Gets a unmodifiable view of the current Samza stream offsets.

getOffsetsAfter(Map<SystemStreamPartition, String>) - Method in interface org.apache.samza.system.SystemAdmin

Fetches the offsets for the messages immediately after the supplied offsets for a group of SystemStreamPartitions.

getOffsetsAfter(Map<SystemStreamPartition, String>) - Method in class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

getOldestOffset() - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

getPartition() - Method in class org.apache.samza.system.SystemStreamPartition

getPartitionId() - Method in class org.apache.samza.Partition

getPartitionKey() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

getProducer(String, Config, MetricsRegistry) - Method in interface org.apache.samza.system.SystemFactory

getSamzaContainerContext() - Method in interface org.apache.samza.task.TaskContext

getSerde(String, Config) - Method in interface org.apache.samza.serializers.SerdeFactory

getShort(String, short) - Method in class org.apache.samza.config.Config

getShort(String) - Method in class org.apache.samza.config.Config

getSize() - Method in class org.apache.samza.metrics.Snapshot

Get the number of values in the collection

getSize() - Method in class org.apache.samza.system.IncomingMessageEnvelope

getSnapshot() - Method in interface org.apache.samza.metrics.Reservoir

Return a Snapshot of this reservoir

getSnapshot() - Method in class org.apache.samza.metrics.SlidingTimeWindowReservoir

getSnapshot() - Method in class org.apache.samza.metrics.Timer

Get the Snapshot

getStatus() - Method in interface org.apache.samza.job.StreamJob

Get current ApplicationStatus of the job

getStorageEngine(String, File, Serde<K>, Serde<V>, MessageCollector, MetricsRegistry, SystemStreamPartition, SamzaContainerContext) - Method in interface org.apache.samza.storage.StorageEngineFactory

Create an instance of the given storage engine.

getStore(String) - Method in interface org.apache.samza.task.TaskContext

getStoreProperties() - Method in interface org.apache.samza.storage.StorageEngine

Get store properties

getStream() - Method in class org.apache.samza.system.SystemStream

getStreamName() - Method in class org.apache.samza.system.SystemStreamMetadata

getSystem() - Method in class org.apache.samza.system.SystemStream

getSystemStream() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

getSystemStream() - Method in class org.apache.samza.system.SystemStreamPartition

getSystemStreamMetadata(Set<String>) - Method in interface org.apache.samza.system.SystemAdmin

Fetch metadata from a system for a set of streams.

getSystemStreamMetadata(Set<String>) - Method in class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

getSystemStreamPartition() - Method in class org.apache.samza.operators.data.IncomingSystemMessageEnvelope

getSystemStreamPartition() - Method in class org.apache.samza.system.IncomingMessageEnvelope

getSystemStreamPartitionCounts(Set<String>, long) - Method in interface org.apache.samza.system.ExtendedSystemAdmin

getSystemStreamPartitionGrouper(Config) - Method in interface org.apache.samza.container.grouper.stream.SystemStreamPartitionGrouperFactory

getSystemStreamPartitionMetadata() - Method in class org.apache.samza.system.SystemStreamMetadata

getSystemStreamPartitions() - Method in interface org.apache.samza.task.TaskContext

getTaskName() - Method in class org.apache.samza.container.TaskName

getTaskName() - Method in interface org.apache.samza.task.TaskContext

getTimerValues(String, String) - Method in interface org.apache.samza.metrics.MetricsAccessor

Get the values of a timer

getTriggers() - Method in class org.apache.samza.operators.triggers.AnyTrigger

getUpcomingOffset() - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

getValue() - Method in class org.apache.samza.metrics.Gauge

getValue() - Method in class org.apache.samza.storage.kv.Entry

getValue() - Method in class org.apache.samza.util.BlockingEnvelopeMap.BufferGauge

getValue() - Method in class org.apache.samza.util.BlockingEnvelopeMap.BufferSizeGauge

getValues() - Method in class org.apache.samza.metrics.Snapshot

Return the entire list of values

getWindowId() - Method in class org.apache.samza.operators.windows.WindowKey

globalWindow(BiFunction<M, WV, WV>) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into a single global window.

globalWindow() - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into a single global window.

group(Set<SystemStreamPartition>) - Method in interface org.apache.samza.container.grouper.stream.SystemStreamPartitionGrouper

H

hash - Variable in class org.apache.samza.system.SystemStreamPartition

hashCode() - Method in class org.apache.samza.checkpoint.Checkpoint

hashCode() - Method in class org.apache.samza.config.MapConfig

hashCode() - Method in class org.apache.samza.container.TaskName

hashCode() - Method in class org.apache.samza.operators.data.LongOffset

hashCode() - Method in class org.apache.samza.Partition

hashCode() - Method in class org.apache.samza.system.IncomingMessageEnvelope

hashCode() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

hashCode() - Method in class org.apache.samza.system.SystemStream

hashCode() - Method in class org.apache.samza.system.SystemStreamMetadata

hashCode() - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

hashCode() - Method in class org.apache.samza.system.SystemStreamPartition

hasNext() - Method in class org.apache.samza.system.SystemStreamPartitionIterator

I

id - Variable in class org.apache.samza.container.SamzaContainerContext

id - Variable in class org.apache.samza.job.CommandBuilder

inc() - Method in class org.apache.samza.metrics.Counter

inc(long) - Method in class org.apache.samza.metrics.Counter

incBlockingPoll(SystemStreamPartition) - Method in class org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics

incBlockingTimeoutPoll(SystemStreamPartition) - Method in class org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics

IncomingMessageEnvelope - Class in org.apache.samza.system

This class represents a message entvelope that is received by a StreamTask for each message that is received from a partition of a specific input stream.

IncomingMessageEnvelope(SystemStreamPartition, String, Object, Object) - Constructor for class org.apache.samza.system.IncomingMessageEnvelope

Constructs a new IncomingMessageEnvelope from specified components.

IncomingMessageEnvelope(SystemStreamPartition, String, Object, Object, int) - Constructor for class org.apache.samza.system.IncomingMessageEnvelope

Constructs a new IncomingMessageEnvelope from specified components.

IncomingSystemMessageEnvelope - Class in org.apache.samza.operators.data

A MessageEnvelope that provides additional information about its input SystemStreamPartition and its Offset within the SystemStreamPartition.

IncomingSystemMessageEnvelope(IncomingMessageEnvelope) - Constructor for class org.apache.samza.operators.data.IncomingSystemMessageEnvelope

Creates an IncomingSystemMessageEnvelope from the IncomingMessageEnvelope.

incPoll() - Method in class org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics

init(Config) - Method in interface org.apache.samza.metrics.MetricsValidator

Initialize with config.

init(Config, TaskContext) - Method in interface org.apache.samza.task.InitableTask

Called by TaskRunner each time an implementing task is created.

InitableTask - Interface in org.apache.samza.task

Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks are instantiated by TaskRunner.

initMetrics(SystemStreamPartition) - Method in class org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics

InterfaceStability - Class in org.apache.samza.annotation

Annotation to inform users of how much to rely on a particular package, class or method not changing over time.

InterfaceStability() - Constructor for class org.apache.samza.annotation.InterfaceStability

InterfaceStability.Evolving - Annotation Type in org.apache.samza.annotation

Evolving, but can break compatibility at minor release (i.e.

InterfaceStability.Stable - Annotation Type in org.apache.samza.annotation

Can evolve while retaining compatibility for minor release boundaries.; can break compatibility only at major release (ie.

InterfaceStability.Unstable - Annotation Type in org.apache.samza.annotation

No guarantee is provided as to reliability or stability across any level of release granularity.

isAtHead(SystemStreamPartition) - Method in class org.apache.samza.util.BlockingEnvelopeMap

isDelete() - Method in interface org.apache.samza.operators.data.MessageEnvelope

Whether this MessageEnvelope indicates deletion of a previous message with this key.

isEmpty() - Method in class org.apache.samza.config.MapConfig

isEndOfStream() - Method in class org.apache.samza.system.IncomingMessageEnvelope

isLoggedStore() - Method in class org.apache.samza.storage.StoreProperties

Flag to indicate whether a store is associated with a changelog (used for recovery) or not

isPersistedToDisk() - Method in class org.apache.samza.storage.StoreProperties

Flag to indicate whether a store can be persisted to disk or not

J

join(MessageStream<OM>, JoinFunction<M, OM, RM>) - Method in interface org.apache.samza.operators.MessageStream

Joins this MessageStream with another MessageStream using the provided pairwise JoinFunction.

JoinFunction<M extends MessageEnvelope,JM extends MessageEnvelope,RM extends MessageEnvelope> - Interface in org.apache.samza.operators.functions

A function that joins MessageEnvelopes from two MessageStreams and produces a joined MessageEnvelope.

K

keyedGlobalWindow(Function<M, K>, BiFunction<M, WV, WV>) - Static method in class org.apache.samza.operators.windows.Windows

Returns a global Window that groups incoming MessageEnvelopes using the provided keyFn.

keyedGlobalWindow(Function<M, K>) - Static method in class org.apache.samza.operators.windows.Windows

Returns a global Window that groups incoming MessageEnvelopes using the provided keyFn.

keyedSessionWindow(Function<M, K>, Duration, BiFunction<M, WV, WV>) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into sessions per-key based on the provided sessionGap and applies the provided fold function to them.

keyedSessionWindow(Function<M, K>, Duration) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into sessions per-key based on the provided sessionGap.

keyedTumblingWindow(Function<M, K>, Duration, BiFunction<M, WV, WV>) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into fixed-size, non-overlapping processing time based windows based on the provided keyFn and applies the provided fold function to them.

keyedTumblingWindow(Function<M, K>, Duration) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into fixed-size, non-overlapping processing time based windows using the provided keyFn.

keySet() - Method in class org.apache.samza.config.MapConfig

KeyValueIterator<K,V> - Interface in org.apache.samza.storage.kv

KeyValueStore<K,V> - Interface in org.apache.samza.storage.kv

A key-value store that supports put, get, delete, and range queries.

KeyValueStore.Extension - Class in org.apache.samza.storage.kv

Represents an extension for classes that implement KeyValueStore.

kill() - Method in interface org.apache.samza.job.StreamJob

Kill this job immediately.

L

listen(ReadableMetricsRegistryListener) - Method in interface org.apache.samza.metrics.ReadableMetricsRegistry

LongOffset - Class in org.apache.samza.operators.data

An implementation of Offset, w/ long value as the offset

LongOffset(String) - Constructor for class org.apache.samza.operators.data.LongOffset

M

map(MapFunction<M, TM>) - Method in interface org.apache.samza.operators.MessageStream

Applies the provided 1:1 MapFunction to MessageEnvelopes in this MessageStream and returns the transformed MessageStream.

MapConfig - Class in org.apache.samza.config

A Config backed by a Java Map

MapConfig() - Constructor for class org.apache.samza.config.MapConfig

MapConfig(Map<String, String>) - Constructor for class org.apache.samza.config.MapConfig

MapConfig(List<Map<String, String>>) - Constructor for class org.apache.samza.config.MapConfig

MapFunction<M extends MessageEnvelope,OM extends MessageEnvelope> - Interface in org.apache.samza.operators.functions

A function that transforms a MessageEnvelope into another MessageEnvelope, possibly of a different type.

merge(Collection<MessageStream<M>>) - Method in interface org.apache.samza.operators.MessageStream

Merge all otherStreams with this MessageStream.

MessageChooser - Interface in org.apache.samza.system.chooser

MessageChooser is an interface for programmatic fine-grain control over stream consumption.

MessageChooserFactory - Interface in org.apache.samza.system.chooser

Build an instance of a MessageChooser

MessageCollector - Interface in org.apache.samza.task

Used as an interface for the means of sending message envelopes to an output stream.

MessageEnvelope<K,M> - Interface in org.apache.samza.operators.data

An entry in the input/output MessageStreams.

MessageStream<M extends MessageEnvelope> - Interface in org.apache.samza.operators

Represents a stream of MessageEnvelopes.

Metric - Interface in org.apache.samza.metrics

Metric class that allows metric visitors to visit it to get its information.

MetricsAccessor - Interface in org.apache.samza.metrics

A MetricsAccessor allows users to retrieve metric values, based on group name and metric name, though specific metrics system, such as JMX.

MetricsRegistry - Interface in org.apache.samza.metrics

A MetricsRegistry allows its users to create new Metrics and have those metrics wired to specific metrics systems, such as JMX, provided by MetricsReporters.

MetricsReporter - Interface in org.apache.samza.metrics

A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive metrics from the Samza framework and Samza jobs.

MetricsReporterFactory - Interface in org.apache.samza.metrics

Build a MetricsReporter

MetricsValidationFailureException - Exception in org.apache.samza.metrics

Thrown when the metrics validation fails.

MetricsValidationFailureException(String) - Constructor for exception org.apache.samza.metrics.MetricsValidationFailureException

MetricsValidationFailureException(String, Throwable) - Constructor for exception org.apache.samza.metrics.MetricsValidationFailureException

MetricsValidator - Interface in org.apache.samza.metrics

A MetricsValidator reads the job's metrics values by using the MetricsAccessor, and validate them.

MetricsVisitor - Class in org.apache.samza.metrics

A MetricsVisitor can be used to process each metric in a ReadableMetricsRegistry, encapsulating the logic of what to be done with each metric in the counter and gauge methods.

MetricsVisitor() - Constructor for class org.apache.samza.metrics.MetricsVisitor

N

newBlockingQueue() - Method in class org.apache.samza.util.BlockingEnvelopeMap

newCounter(String, String) - Method in interface org.apache.samza.metrics.MetricsRegistry

Create and register a new Counter

newCounter(String, Counter) - Method in interface org.apache.samza.metrics.MetricsRegistry

Register existing Counter with this registry

newCounter(String, String) - Method in class org.apache.samza.util.NoOpMetricsRegistry

newCounter(String, Counter) - Method in class org.apache.samza.util.NoOpMetricsRegistry

newGauge(String, String, T) - Method in interface org.apache.samza.metrics.MetricsRegistry

Create and register a new Gauge

newGauge(String, Gauge<T>) - Method in interface org.apache.samza.metrics.MetricsRegistry

Register an existing Gauge

newGauge(String, String, T) - Method in class org.apache.samza.util.NoOpMetricsRegistry

newGauge(String, Gauge<T>) - Method in class org.apache.samza.util.NoOpMetricsRegistry

newTimer(String, String) - Method in interface org.apache.samza.metrics.MetricsRegistry

Create and Register a new Timer

newTimer(String, Timer) - Method in interface org.apache.samza.metrics.MetricsRegistry

Register existing Timer with this registry

newTimer(String, String) - Method in class org.apache.samza.util.NoOpMetricsRegistry

newTimer(String, Timer) - Method in class org.apache.samza.util.NoOpMetricsRegistry

next() - Method in class org.apache.samza.system.SystemStreamPartitionIterator

NoOpMetricsRegistry - Class in org.apache.samza.util

MetricsRegistry implementation for when no actual metrics need to be recorded but a registry is still required.

NoOpMetricsRegistry() - Constructor for class org.apache.samza.util.NoOpMetricsRegistry

O

of(WindowKey<K>, M) - Static method in class org.apache.samza.operators.windows.WindowPane

Offset - Interface in org.apache.samza.operators.data

A generic interface extending Comparable to be used as Offset in a stream

offsetComparator(String, String) - Method in interface org.apache.samza.system.SystemAdmin

Compare the two offsets.

offsetComparator(String, String) - Method in class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

onCheckpoint(Map<SystemStreamPartition, String>) - Method in interface org.apache.samza.checkpoint.CheckpointListener

onCounter(String, Counter) - Method in interface org.apache.samza.metrics.ReadableMetricsRegistryListener

onEndOfStream(MessageCollector, TaskCoordinator) - Method in interface org.apache.samza.task.EndOfStreamListenerTask

Guaranteed to be invoked when all SSPs processed by this task have reached their end-of-stream.

onGauge(String, Gauge<?>) - Method in interface org.apache.samza.metrics.ReadableMetricsRegistryListener

onTimer(String, Timer) - Method in interface org.apache.samza.metrics.ReadableMetricsRegistryListener

org.apache.samza - package org.apache.samza

org.apache.samza.annotation - package org.apache.samza.annotation

org.apache.samza.checkpoint - package org.apache.samza.checkpoint

org.apache.samza.config - package org.apache.samza.config

org.apache.samza.container - package org.apache.samza.container

org.apache.samza.container.grouper.stream - package org.apache.samza.container.grouper.stream

org.apache.samza.job - package org.apache.samza.job

org.apache.samza.metrics - package org.apache.samza.metrics

org.apache.samza.operators - package org.apache.samza.operators

org.apache.samza.operators.data - package org.apache.samza.operators.data

org.apache.samza.operators.functions - package org.apache.samza.operators.functions

org.apache.samza.operators.triggers - package org.apache.samza.operators.triggers

org.apache.samza.operators.windows - package org.apache.samza.operators.windows

org.apache.samza.operators.windows.internal - package org.apache.samza.operators.windows.internal

org.apache.samza.serializers - package org.apache.samza.serializers

org.apache.samza.storage - package org.apache.samza.storage

org.apache.samza.storage.kv - package org.apache.samza.storage.kv

org.apache.samza.system - package org.apache.samza.system

org.apache.samza.system.chooser - package org.apache.samza.system.chooser

org.apache.samza.task - package org.apache.samza.task

org.apache.samza.util - package org.apache.samza.util

OutgoingMessageEnvelope - Class in org.apache.samza.system

An OutgoingMessageEnvelope is sent to a specified SystemStream via the appropriate SystemProducer from the user's StreamTask.

OutgoingMessageEnvelope(SystemStream, String, String, Object, Object, Object) - Constructor for class org.apache.samza.system.OutgoingMessageEnvelope

Constructs a new OutgoingMessageEnvelope from specified components.

OutgoingMessageEnvelope(SystemStream, Object, Object, Object) - Constructor for class org.apache.samza.system.OutgoingMessageEnvelope

Constructs a new OutgoingMessageEnvelope from specified components.

OutgoingMessageEnvelope(SystemStream, Object, Object) - Constructor for class org.apache.samza.system.OutgoingMessageEnvelope

Constructs a new OutgoingMessageEnvelope from specified components.

OutgoingMessageEnvelope(SystemStream, Object) - Constructor for class org.apache.samza.system.OutgoingMessageEnvelope

Constructs a new OutgoingMessageEnvelope from specified components.

P

Partition - Class in org.apache.samza

A numbered, ordered partition of a stream.

Partition(int) - Constructor for class org.apache.samza.Partition

Constructs a new Samza stream partition from a specified partition number.

partition - Variable in class org.apache.samza.system.SystemStreamPartition

poll(Set<SystemStreamPartition>, long) - Method in interface org.apache.samza.system.SystemConsumer

Poll the SystemConsumer to get any available messages from the underlying system.

poll(Set<SystemStreamPartition>, long) - Method in class org.apache.samza.util.BlockingEnvelopeMap

Poll the SystemConsumer to get any available messages from the underlying system.

process(IncomingMessageEnvelope, MessageCollector, TaskCoordinator) - Method in interface org.apache.samza.task.StreamTask

Called once for each message that this StreamTask receives.

processAsync(IncomingMessageEnvelope, MessageCollector, TaskCoordinator, TaskCallback) - Method in interface org.apache.samza.task.AsyncStreamTask

Called once for each message that this AsyncStreamTask receives.

put(String, String) - Method in class org.apache.samza.config.Config

put(K, V) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Updates the mapping of the specified key-value pair; Associates the specified key with the specified value.

put(SystemStreamPartition, IncomingMessageEnvelope) - Method in class org.apache.samza.util.BlockingEnvelopeMap

Place a new IncomingMessageEnvelope on the queue for the specified SystemStreamPartition.

putAll(Map<? extends String, ? extends String>) - Method in class org.apache.samza.config.Config

putAll(List<Entry<K, V>>) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Updates the mappings of the specified key-value entries.

putAll(SystemStreamPartition, List<IncomingMessageEnvelope>) - Method in class org.apache.samza.util.BlockingEnvelopeMap

Place a collection of IncomingMessageEnvelope on the queue for the specified SystemStreamPartition.

R

range(K, K) - Method in interface org.apache.samza.storage.kv.KeyValueStore

Returns an iterator for a sorted range of entries specified by [from, to).

ReadableMetricsRegistry - Interface in org.apache.samza.metrics

A ReadableMetricsRegistry is a MetricsRegistry that also allows read access to the metrics for which it is responsible.

ReadableMetricsRegistryListener - Interface in org.apache.samza.metrics

readLastCheckpoint(TaskName) - Method in interface org.apache.samza.checkpoint.CheckpointManager

Returns the last recorded checkpoint for a specified taskName.

regexSubset(String) - Method in class org.apache.samza.config.Config

register(TaskName) - Method in interface org.apache.samza.checkpoint.CheckpointManager

Registers this manager to write checkpoints of a specific Samza stream partition.

register(String, ReadableMetricsRegistry) - Method in interface org.apache.samza.metrics.MetricsReporter

register(SystemStreamPartition, String) - Method in class org.apache.samza.system.chooser.BaseMessageChooser

register(SystemStreamPartition, String) - Method in interface org.apache.samza.system.chooser.MessageChooser

Called before start, to let the chooser know that it will be handling envelopes from the given SystemStreamPartition.

register(SystemStreamPartition, String) - Method in interface org.apache.samza.system.SystemConsumer

Register a SystemStreamPartition to this SystemConsumer.

register(String) - Method in interface org.apache.samza.system.SystemProducer

Registers this producer to send messages from a specified Samza source, such as a StreamTask.

register(SystemStreamPartition, String) - Method in class org.apache.samza.util.BlockingEnvelopeMap

Register a SystemStreamPartition to this SystemConsumer.

remove(Object) - Method in class org.apache.samza.config.Config

remove() - Method in class org.apache.samza.system.SystemStreamPartitionIterator

repeat(Trigger<M>) - Static method in class org.apache.samza.operators.triggers.Triggers

Repeats the provided trigger forever.

Reservoir - Interface in org.apache.samza.metrics

A reservoir interface to store, update and display values

restore(Iterator<IncomingMessageEnvelope>) - Method in interface org.apache.samza.storage.StorageEngine

Restore the content of this StorageEngine from the changelog.

rewrite(String, Config) - Method in interface org.apache.samza.config.ConfigRewriter

S

SamzaContainerContext - Class in org.apache.samza.container

A SamzaContainerContext maintains per-container information for the tasks it executes.

SamzaContainerContext(int, Config, Collection<TaskName>) - Constructor for class org.apache.samza.container.SamzaContainerContext

An immutable context object that can passed to tasks to give them information about the container in which they are executing.

SamzaException - Exception in org.apache.samza

Unchecked exception that Samza throws when something goes wrong.

SamzaException() - Constructor for exception org.apache.samza.SamzaException

SamzaException(String, Throwable) - Constructor for exception org.apache.samza.SamzaException

SamzaException(String) - Constructor for exception org.apache.samza.SamzaException

SamzaException(Throwable) - Constructor for exception org.apache.samza.SamzaException

sanitize() - Method in class org.apache.samza.config.Config

sanitize() - Method in class org.apache.samza.config.MapConfig

send(String, OutgoingMessageEnvelope) - Method in interface org.apache.samza.system.SystemProducer

Sends a specified message envelope from a specified Samza source.

send(OutgoingMessageEnvelope) - Method in interface org.apache.samza.task.MessageCollector

Sends message envelope out onto specified stream.

SENSITIVE_MASK - Static variable in class org.apache.samza.config.Config

SENSITIVE_PREFIX - Static variable in class org.apache.samza.config.Config

Serde<T> - Interface in org.apache.samza.serializers

A Serde is a convenience type that implements both the Serializer and Deserializer interfaces, allowing it to both read and write data in its value type, T.

SerdeFactory<T> - Interface in org.apache.samza.serializers

Build an instance of Serde

Serializer<T> - Interface in org.apache.samza.serializers

A standard interface for Samza compatible serializers, used for serializing objects to bytes.

set(long) - Method in class org.apache.samza.metrics.Counter

set(T) - Method in class org.apache.samza.metrics.Gauge

setAccumulationMode(AccumulationMode) - Method in class org.apache.samza.operators.windows.internal.WindowInternal

setAccumulationMode(AccumulationMode) - Method in interface org.apache.samza.operators.windows.Window

Specify how a Window should process its previously emitted WindowPanes.

setCommandPath(String) - Method in class org.apache.samza.job.CommandBuilder

setConfig(Config) - Method in class org.apache.samza.job.CommandBuilder

setEarlyTrigger(Trigger) - Method in class org.apache.samza.operators.windows.internal.WindowInternal

setEarlyTrigger(Trigger<M>) - Method in interface org.apache.samza.operators.windows.Window

Set the early triggers for this Window.

setId(int) - Method in class org.apache.samza.job.CommandBuilder

setIsAtHead(SystemStreamPartition, boolean) - Method in class org.apache.samza.util.BlockingEnvelopeMap

setLateTrigger(Trigger) - Method in class org.apache.samza.operators.windows.internal.WindowInternal

setLateTrigger(Trigger<M>) - Method in interface org.apache.samza.operators.windows.Window

Set the late triggers for this Window.

setLoggedStore(boolean) - Method in class org.apache.samza.storage.StoreProperties.StorePropertiesBuilder

setNoMoreMessages(SystemStreamPartition, boolean) - Method in class org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics

setPersistedToDisk(boolean) - Method in class org.apache.samza.storage.StoreProperties.StorePropertiesBuilder

setStartingOffset(SystemStreamPartition, String) - Method in interface org.apache.samza.task.TaskContext

Set the starting offset for the given SystemStreamPartition.

setUrl(URL) - Method in class org.apache.samza.job.CommandBuilder

shutdown(TaskCoordinator.RequestScope) - Method in interface org.apache.samza.task.TaskCoordinator

Requests that the container should be shut down.

SinglePartitionWithoutOffsetsSystemAdmin - Class in org.apache.samza.util

A simple helper admin class that defines a single partition (partition 0) for a given system.

SinglePartitionWithoutOffsetsSystemAdmin() - Constructor for class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

sink(SinkFunction<M>) - Method in interface org.apache.samza.operators.MessageStream

Allows sending MessageEnvelopes in this MessageStream to an output SystemStream using the provided SinkFunction.

SinkFunction<M extends MessageEnvelope> - Interface in org.apache.samza.operators.functions

A function that allows sending a MessageEnvelope to an output system.

size() - Method in class org.apache.samza.config.MapConfig

size() - Method in interface org.apache.samza.metrics.Reservoir

Return the number of values in this reservoir

size() - Method in class org.apache.samza.metrics.SlidingTimeWindowReservoir

SlidingTimeWindowReservoir - Class in org.apache.samza.metrics

An implemented Reservoir used to store values that appear in a sliding time window

SlidingTimeWindowReservoir() - Constructor for class org.apache.samza.metrics.SlidingTimeWindowReservoir

Default constructor using default window size

SlidingTimeWindowReservoir(long) - Constructor for class org.apache.samza.metrics.SlidingTimeWindowReservoir

Construct the SlidingTimeWindowReservoir with window size

SlidingTimeWindowReservoir(long, Clock) - Constructor for class org.apache.samza.metrics.SlidingTimeWindowReservoir

SlidingTimeWindowReservoir(long, int, Clock) - Constructor for class org.apache.samza.metrics.SlidingTimeWindowReservoir

Snapshot - Class in org.apache.samza.metrics

A statistical snapshot of a collection of values

Snapshot(Collection<Long>) - Constructor for class org.apache.samza.metrics.Snapshot

start() - Method in interface org.apache.samza.checkpoint.CheckpointManager

start() - Method in interface org.apache.samza.metrics.MetricsReporter

start() - Method in class org.apache.samza.system.chooser.BaseMessageChooser

start() - Method in interface org.apache.samza.system.chooser.MessageChooser

Called after all SystemStreamPartitions have been registered.

start() - Method in interface org.apache.samza.system.SystemConsumer

Tells the SystemConsumer to connect to the underlying system, and prepare to begin serving messages when poll is invoked.

start() - Method in interface org.apache.samza.system.SystemProducer

Start the SystemProducer.

stop() - Method in interface org.apache.samza.checkpoint.CheckpointManager

stop() - Method in interface org.apache.samza.metrics.MetricsReporter

stop() - Method in interface org.apache.samza.storage.StorageEngine

Close the storage engine

stop() - Method in class org.apache.samza.system.chooser.BaseMessageChooser

stop() - Method in interface org.apache.samza.system.chooser.MessageChooser

Called when the chooser is about to be discarded.

stop() - Method in interface org.apache.samza.system.SystemConsumer

Tells the SystemConsumer to close all connections, release all resource, and shut down everything.

stop() - Method in interface org.apache.samza.system.SystemProducer

Stop the SystemProducer.

StorageEngine - Interface in org.apache.samza.storage

A storage engine for managing state maintained by a stream processor.

StorageEngineFactory<K,V> - Interface in org.apache.samza.storage

An object provided by the storage engine implementation to create instances of the given storage engine type.

StoreProperties - Class in org.apache.samza.storage

Immutable class that defines the properties of a Store

StoreProperties.StorePropertiesBuilder - Class in org.apache.samza.storage

StorePropertiesBuilder() - Constructor for class org.apache.samza.storage.StoreProperties.StorePropertiesBuilder

stream - Variable in class org.apache.samza.system.SystemStream

StreamJob - Interface in org.apache.samza.job

A StreamJob runs Samza StreamTasks in its specific environment.

StreamJobFactory - Interface in org.apache.samza.job

Build a StreamJob

StreamOperatorTask - Interface in org.apache.samza.operators

A StreamOperatorTask is the basic interface to implement for processing MessageStreams.

StreamTask - Interface in org.apache.samza.task

A StreamTask is the basic class on which Samza jobs are implemented.

StreamTaskFactory - Interface in org.apache.samza.task

Build StreamTask instances.

submit() - Method in interface org.apache.samza.job.StreamJob

Submit this job to be run.

subset(String) - Method in class org.apache.samza.config.Config

subset(String, boolean) - Method in class org.apache.samza.config.Config

system - Variable in class org.apache.samza.system.SystemStream

SystemAdmin - Interface in org.apache.samza.system

Helper interface attached to an underlying system to fetch information about streams, partitions, offsets, etc.

SystemConsumer - Interface in org.apache.samza.system

SystemConsumer is the interface that must be implemented by any system that wishes to integrate with Samza.

SystemFactory - Interface in org.apache.samza.system

Build the SystemConsumer and SystemProducer for a particular system, as well as the accompanying SystemAdmin.

SystemProducer - Interface in org.apache.samza.system

SystemProducers are how Samza writes messages from StreamTasks to outside systems, such as messaging systems like Kafka, or file systems.

SystemStream - Class in org.apache.samza.system

Streams in Samza consist of both the stream name and the system to which the stream belongs.

SystemStream(String, String) - Constructor for class org.apache.samza.system.SystemStream

Constructs a Samza stream object from specified components.

SystemStream(SystemStream) - Constructor for class org.apache.samza.system.SystemStream

Constructs a Samza stream object based upon an existing Samza stream.

SystemStreamMetadata - Class in org.apache.samza.system

SystemAdmins use this class to return useful metadata about a stream's offset and partition information.

SystemStreamMetadata(String, Map<Partition, SystemStreamMetadata.SystemStreamPartitionMetadata>) - Constructor for class org.apache.samza.system.SystemStreamMetadata

SystemStreamMetadata.OffsetType - Enum in org.apache.samza.system

OffsetType is an enum used to define which offset should be used when reading from a SystemStreamPartition for the first time.

SystemStreamMetadata.SystemStreamPartitionMetadata - Class in org.apache.samza.system

Provides offset information for a given SystemStreamPartition.

SystemStreamPartition - Class in org.apache.samza.system

Aggregate object representing a both the SystemStream and Partition.

SystemStreamPartition(String, String, Partition) - Constructor for class org.apache.samza.system.SystemStreamPartition

Constructs a Samza stream partition object from specified components.

SystemStreamPartition(SystemStreamPartition) - Constructor for class org.apache.samza.system.SystemStreamPartition

Constructs a Samza stream partition object based upon an existing Samza stream partition.

SystemStreamPartition(SystemStream, Partition) - Constructor for class org.apache.samza.system.SystemStreamPartition

Constructs a Samza stream partition object based upon another Samza stream and a specified partition.

SystemStreamPartitionGrouper - Interface in org.apache.samza.container.grouper.stream

Group a set of SystemStreamPartitions into logical taskNames that share a common characteristic, defined by the implementation.

SystemStreamPartitionGrouperFactory - Interface in org.apache.samza.container.grouper.stream

Return an instance a SystemStreamPartitionGrouper per the particular implementation

SystemStreamPartitionIterator - Class in org.apache.samza.system

Iterator that wraps a SystemConsumer to iterate over the messages the consumer provides for the specified SystemStreamPartition.

SystemStreamPartitionIterator(SystemConsumer, SystemStreamPartition) - Constructor for class org.apache.samza.system.SystemStreamPartitionIterator

SystemStreamPartitionIterator(SystemConsumer, SystemStreamPartition, int) - Constructor for class org.apache.samza.system.SystemStreamPartitionIterator

SystemStreamPartitionMatcher - Interface in org.apache.samza.system

SystemStreamPartitionMetadata(String, String, String) - Constructor for class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

T

TaskCallback - Interface in org.apache.samza.task

A TaskCallback is fired by a AsyncStreamTask to notify when an asynchronous process has completed.

TaskContext - Interface in org.apache.samza.task

A TaskContext provides resources about the StreamTask, particularly during initialization in an InitableTask.

TaskCoordinator - Interface in org.apache.samza.task

TaskCoordinators are provided to the process methods of StreamTask implementations to allow the user code to request actions from the Samza framework, including committing the current checkpoints to configured org.apache.samza.checkpoint.CheckpointManager or shutting down the task or all tasks within a container.

TaskCoordinator.RequestScope - Enum in org.apache.samza.task

A task can make requests to the Samza framework while processing messages, such as TaskCoordinator.commit(RequestScope) and TaskCoordinator.shutdown(RequestScope).

TaskName - Class in org.apache.samza.container

A unique identifier of a set of a SystemStreamPartitions that have been grouped by a SystemStreamPartitionGrouper.

TaskName(String) - Constructor for class org.apache.samza.container.TaskName

taskNames - Variable in class org.apache.samza.container.SamzaContainerContext

timer(Timer) - Method in class org.apache.samza.metrics.MetricsVisitor

Timer - Class in org.apache.samza.metrics

A timer metric that stores time duration and provides Snapshot of the durations.

Timer(String) - Constructor for class org.apache.samza.metrics.Timer

Default constructor.

Timer(String, long, Clock) - Constructor for class org.apache.samza.metrics.Timer

Construct a Timer with given window size

Timer(String, long, int, Clock) - Constructor for class org.apache.samza.metrics.Timer

Construct a Timer with given window size and collision buffer

Timer(String, Reservoir) - Constructor for class org.apache.samza.metrics.Timer

Construct a Timer with given Reservoir

timeSinceFirstMessage(Duration) - Static method in class org.apache.samza.operators.triggers.Triggers

Creates a trigger that fires after the specified duration has passed since the first MessageEnvelope in the pane.

TimeSinceFirstMessageTrigger<M extends MessageEnvelope> - Class in org.apache.samza.operators.triggers

timeSinceLastMessage(Duration) - Static method in class org.apache.samza.operators.triggers.Triggers

Creates a trigger that fires when there is no new MessageEnvelope for the specified duration in the pane.

TimeSinceLastMessageTrigger<M extends MessageEnvelope> - Class in org.apache.samza.operators.triggers

TimeTrigger<M extends MessageEnvelope> - Class in org.apache.samza.operators.triggers

TimeTrigger(Duration) - Constructor for class org.apache.samza.operators.triggers.TimeTrigger

toBytes(T) - Method in interface org.apache.samza.serializers.Serializer

Serializes given object to an array of bytes.

toString() - Method in class org.apache.samza.checkpoint.Checkpoint

toString() - Method in class org.apache.samza.config.MapConfig

toString() - Method in class org.apache.samza.container.TaskName

toString() - Method in enum org.apache.samza.job.ApplicationStatus

toString() - Method in class org.apache.samza.metrics.Counter

toString() - Method in class org.apache.samza.metrics.Gauge

toString() - Method in class org.apache.samza.Partition

toString() - Method in class org.apache.samza.system.IncomingMessageEnvelope

toString() - Method in class org.apache.samza.system.OutgoingMessageEnvelope

toString() - Method in class org.apache.samza.system.SystemStream

toString() - Method in class org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

toString() - Method in class org.apache.samza.system.SystemStreamMetadata

toString() - Method in class org.apache.samza.system.SystemStreamPartition

transform(Map<SystemStreamPartition, MessageStream<IncomingSystemMessageEnvelope>>) - Method in interface org.apache.samza.operators.StreamOperatorTask

Describe the transformation steps for each MessageStreams for this task using the MessageStream APIs.

Trigger<M extends MessageEnvelope> - Interface in org.apache.samza.operators.triggers

Marker interface for all triggers.

Triggers<M extends MessageEnvelope> - Class in org.apache.samza.operators.triggers

API for creating Trigger instances to be used with a Window.

tumblingWindow(Duration, BiFunction<M, WV, WV>) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that windows values into fixed-size processing time based windows and aggregates them applying the provided function.

tumblingWindow(Duration) - Static method in class org.apache.samza.operators.windows.Windows

Creates a Window that groups incoming MessageEnvelopes into fixed-size, non-overlapping processing time based windows.

U

unlisten(ReadableMetricsRegistryListener) - Method in interface org.apache.samza.metrics.ReadableMetricsRegistry

update(long) - Method in interface org.apache.samza.metrics.Reservoir

Update the reservoir with the new value

update(long) - Method in class org.apache.samza.metrics.SlidingTimeWindowReservoir

update(long) - Method in class org.apache.samza.metrics.Timer

Add the time duration

update(IncomingMessageEnvelope) - Method in interface org.apache.samza.system.chooser.MessageChooser

Notify the chooser that a new envelope is available for a processing.

url - Variable in class org.apache.samza.job.CommandBuilder

V

validate(MetricsAccessor) - Method in interface org.apache.samza.metrics.MetricsValidator

Validate the metrics values of a job

validateChangelogStream(String, int) - Method in interface org.apache.samza.system.SystemAdmin

Validates change log stream

validateChangelogStream(String, int) - Method in class org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin

valueOf(String) - Static method in enum org.apache.samza.job.ApplicationStatus

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

valueOf(String) - Static method in enum org.apache.samza.operators.triggers.DurationCharacteristic

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

valueOf(String) - Static method in enum org.apache.samza.operators.windows.AccumulationMode

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

valueOf(String) - Static method in enum org.apache.samza.system.SystemStreamMetadata.OffsetType

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

valueOf(String) - Static method in enum org.apache.samza.task.TaskCoordinator.RequestScope

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

values() - Method in class org.apache.samza.config.MapConfig

values() - Static method in enum org.apache.samza.job.ApplicationStatus

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

values() - Static method in enum org.apache.samza.operators.triggers.DurationCharacteristic

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

values() - Static method in enum org.apache.samza.operators.windows.AccumulationMode

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

values() - Static method in enum org.apache.samza.system.SystemStreamMetadata.OffsetType

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

values() - Static method in enum org.apache.samza.task.TaskCoordinator.RequestScope

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

visit(MetricsVisitor) - Method in class org.apache.samza.metrics.Counter

visit(MetricsVisitor) - Method in class org.apache.samza.metrics.Gauge

visit(MetricsVisitor) - Method in interface org.apache.samza.metrics.Metric

visit(Metric) - Method in class org.apache.samza.metrics.MetricsVisitor

visit(MetricsVisitor) - Method in class org.apache.samza.metrics.Timer

W

waitForFinish(long) - Method in interface org.apache.samza.job.StreamJob

Block on this job until either it finishes or reaches its timeout value

waitForStatus(ApplicationStatus, long) - Method in interface org.apache.samza.job.StreamJob

Block on this job until either it transitions to the specified status or reaches it timeout value

window(Window<M, K, WV, WM>) - Method in interface org.apache.samza.operators.MessageStream

Groups and processes the MessageEnvelopes in this MessageStream according to the provided Window (e.g.

Window<M extends MessageEnvelope,K,WV,WM extends WindowPane<K,WV>> - Interface in org.apache.samza.operators.windows

Groups incoming MessageEnvelopes in the MessageStream into finite windows for processing.

window(MessageCollector, TaskCoordinator) - Method in interface org.apache.samza.task.WindowableTask

Called by TaskRunner for each implementing task at the end of every specified window.

WindowableTask - Interface in org.apache.samza.task

Add-on interface to StreamTask implementations to add code which will be run on a specified time interval (via configuration).

WindowInternal<M extends MessageEnvelope,K,WV> - Class in org.apache.samza.operators.windows.internal

Internal representation of a Window.

WindowInternal(Trigger, BiFunction<M, WV, WV>, Function<M, K>, Function<M, Long>) - Constructor for class org.apache.samza.operators.windows.internal.WindowInternal

WindowKey<K> - Class in org.apache.samza.operators.windows

Key for a WindowPane emitted from a Window.

WindowKey(K, String) - Constructor for class org.apache.samza.operators.windows.WindowKey

WindowPane<K,V> - Class in org.apache.samza.operators.windows

Specifies the result emitted from a Window.

Windows - Class in org.apache.samza.operators.windows

APIs for creating different types of Windows.

writeCheckpoint(TaskName, Checkpoint) - Method in interface org.apache.samza.checkpoint.CheckpointManager

Writes a checkpoint based on the current state of a Samza stream partition.

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