Name | Description | Type | Package | Framework |
ApplicationStatus | enum ApplicationStatusStatus of a StreamJob during and after its run. | Class | org.apache.samza.job | Apache Samza |
|
BaseMessageChooser | An abstract MessageChooser that implements start/stop/register for choosers that don't use them. | Class | org.apache.samza.system.chooser | Apache Samza |
|
BlockingEnvelopeMap | BlockingEnvelopeMap is a helper class for SystemConsumer implementations. | Class | org.apache.samza.util | Apache Samza |
|
Checkpoint | A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each. | Class | org.apache.samza.checkpoint | Apache Samza |
|
CheckpointManager | CheckpointManagers read and write Checkpoint to some implementation-specific location. | Interface | org.apache.samza.checkpoint | Apache Samza |
|
CheckpointManagerFactory | Build a CheckpointManager. | Interface | org.apache.samza.checkpoint | Apache Samza |
|
ClosableTask | 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, | Interface | org.apache.samza.task | Apache Samza |
|
CommandBuilder | CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework, such as YARN or the LocalJobRunner. | Class | org.apache.samza.job | Apache Samza |
|
Config | Store and retrieve named, typed values as configuration for classes implementing this interface. | Class | org.apache.samza.config | Apache Samza |
|
ConfigException | Specific SamzaExceptions thrown from ConfigSee Also:Serialized Form | Class | org.apache.samza.config | Apache Samza |
|
ConfigFactory | | Interface | org.apache.samza.config | Apache Samza |
|
ConfigRewriter | 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. | Interface | org.apache.samza.config | Apache Samza |
|
Counter | A counter is a Metric that represents a cumulative value. | Class | org.apache.samza.metrics | Apache Samza |
|
Deserializer | | Interface | org.apache.samza.serializers | Apache Samza |
|
Gauge | A Gauge is a Metric that wraps some instance of T in a thread-safe reference and allows it to be set or retrieved. | Class | org.apache.samza.metrics | Apache Samza |
|
IncomingMessageEnvelope | This class represents a message envelope that is received by a StreamTask for each message that is received from a partition of a specific input stream. | Class | org.apache.samza.system | Apache Samza |
|
InitableTask | Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks are instantiated by TaskRunner. | Interface | org.apache.samza.task | Apache Samza |
|
MapConfig | | Class | org.apache.samza.config | Apache Samza |
|
MessageChooser | MessageChooser is an interface for programmatic fine-grain control over stream consumption. | Interface | org.apache.samza.system.chooser | Apache Samza |
|
MessageChooserFactory | | Interface | org.apache.samza.system.chooser | Apache Samza |
|
MessageCollector | Used as an interface for the means of sending message envelopes to an output stream. | Interface | org.apache.samza.task | Apache Samza |
|
MetricsRegistry | A MetricsRegistry allows its users to create new Metrics and have those metrics wired to specific metrics systems, such as JMX, provided by MetricsReporters. | Interface | org.apache.samza.metrics | Apache Samza |
|
MetricsReporter | A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive metrics from the Samza framework and Samza jobs. | Interface | org.apache.samza.metrics | Apache Samza |
|
MetricsReporterFactory | | Interface | org.apache.samza.metrics | Apache Samza |
|
MetricsVisitor | 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. | Class | org.apache.samza.metrics | Apache Samza |
|
NoOpMetricsRegistry | MetricsRegistry implementation for when no actual metrics need to be recorded but a registry is still required. | Class | org.apache.samza.util | Apache Samza |
|
OutgoingMessageEnvelope | An OutgoingMessageEnvelope is sent to a specified SystemStream via the appropriate SystemProducer from the user's StreamTask. | Class | org.apache.samza.system | Apache Samza |
|
Partition | A numbered, ordered partition of a stream. | Class | org.apache.samza | Apache Samza |
|
ReadableMetricsRegistry | A ReadableMetricsRegistry is a MetricsRegistry that also allows read access to the metrics for which it is responsible. | Interface | org.apache.samza.metrics | Apache Samza |
|
ReadableMetricsRegistryListener | | Interface | org.apache.samza.metrics | Apache Samza |
|
SamzaContainerContext | A SamzaContainerContext maintains per-container information for the tasks it executes. | Class | org.apache.samza.container | Apache Samza |
|
SamzaException | Unchecked exception that Samza throws when something goes wrong. | Class | org.apache.samza | Apache Samza |
|
Serde | A Serde is a convenience type that implements both the Serializer and Deserializer interfaces, allowing it to both read and write data | Interface | org.apache.samza.serializers | Apache Samza |
|
Serializer | A standard interface for Samza compatible serializers, used for serializing objects to bytes. | Interface | org.apache.samza.serializers | Apache Samza |
|
SinglePartitionWithoutOffsetsSystemAdmin | A simple helper admin class that defines a single partition (partition 0) for a given system. | Class | org.apache.samza.util | Apache Samza |
|
StorageEngine | A storage engine for managing state maintained by a stream processor. | Interface | org.apache.samza.storage | Apache Samza |
|
StorageEngineFactory | An object provided by the storage engine implementation to create instances of the given storage engine type. | Interface | org.apache.samza.storage | Apache Samza |
|
StreamJob | A StreamJob runs Samza StreamTasks in its specific environment. | Interface | org.apache.samza.job | Apache Samza |
|
StreamTask | A StreamTask is the basic class on which Samza jobs are implemented. | Interface | org.apache.samza.task | Apache Samza |
|
SystemAdmin | Helper interface attached to an underlying system to fetch information about streams, partitions, offsets, etc. | Interface | org.apache.samza.system | Apache Samza |
|
SystemConsumer | SystemConsumer is the interface that must be implemented by any system that wishes to integrate with Samza. | Interface | org.apache.samza.system | Apache Samza |
|
SystemFactory | Build the SystemConsumer and SystemProducer for a particular system, as well as the accompanying SystemAdmin. | Interface | org.apache.samza.system | Apache Samza |
|
SystemProducer | SystemProducers are how Samza writes messages from StreamTasks to outside systems, such as messaging systems like Kafka, or file systems. | Interface | org.apache.samza.system | Apache Samza |
|
SystemStream | Streams in Samza consist of both the stream name and the system to which the stream belongs. | Class | org.apache.samza.system | Apache Samza |
|
SystemStreamMetadata | SystemAdmins use this class to return useful metadata about a stream's offset and partition information. | Class | org.apache.samza.system | Apache Samza |
|
SystemStreamMetadata .OffsetType | OffsetType is an enum used to define which offset should be used when reading from a SystemStreamPartition for the first time. | Class | org.apache.samza.system.SystemStreamMetadata | Apache Samza |
|
SystemStreamMetadata .SystemStreamPartitionMetadata | Provides offset information for a given SystemStreamPartition. | Class | org.apache.samza.system.SystemStreamMetadata | Apache Samza |
|
SystemStreamPartition | Aggregate object representing a both the SystemStream and Partition. | Class | org.apache.samza.system | Apache Samza |
|
SystemStreamPartitionIterator | Iterator that wraps a SystemConsumer to iterate over the messages the consumer provides for the specified SystemStreamPartition. | Class | org.apache.samza.system | Apache Samza |
|
TaskContext | A TaskContext provides resources about the StreamTask, particularly during initialization in an InitableTask and during calls to TaskLifecycleListeners. | Interface | org.apache.samza.task | Apache Samza |
|
TaskCoordinator | 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 | Interface | org.apache.samza.task | Apache Samza |
|
TaskCoordinator .RequestScope | A task can make requests to the Samza framework while processing messages, such as TaskCoordinator. | Class | org.apache.samza.task.TaskCoordinator | Apache Samza |
|
TaskLifecycleListener | Used to get before/after notifications before initializing/closing all tasks in a given container (JVM/process). | Interface | org.apache.samza.task | Apache Samza |
|
TaskLifecycleListenerFactory | | Interface | org.apache.samza.task | Apache Samza |
|
WindowableTask | Add-on interface to StreamTask implementations to add code which will be run on a specified time interval (via configuration). | Interface | org.apache.samza.task | Apache Samza |