diff --git a/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html b/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html
deleted file mode 100644
index 93c48c071cae535bb7e3e7b4af50731d2cbfda01..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html
+++ /dev/null
@@ -1,83 +0,0 @@
-
-
-
-
-
-All Classes (samza-api 0.8.0-SNAPSHOT API)
-All Classes
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html b/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html
deleted file mode 100644
index 5cbcef03bc474f3802b00767aae330199f1c98cc..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html
+++ /dev/null
@@ -1,83 +0,0 @@
-
-
-
-
-
-All Classes (samza-api 0.8.0-SNAPSHOT API)
-All Classes
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/constant-values.html b/docs/learn/documentation/versioned/api/javadocs/constant-values.html
deleted file mode 100644
index d0c1e22d44d841b9996b07d380634f5b4b0328f2..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/constant-values.html
+++ /dev/null
@@ -1,142 +0,0 @@
-
-
-
-
-
-Constant Field Values (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html b/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html
deleted file mode 100644
index d59904b05d194f225e6b6782f90b50be8889e1a1..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-
-
-
-Deprecated List (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/help-doc.html b/docs/learn/documentation/versioned/api/javadocs/help-doc.html
deleted file mode 100644
index ec180841f31d19cbea5d4ed7fadadb071a633115..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/help-doc.html
+++ /dev/null
@@ -1,214 +0,0 @@
-
-
-
-
-
-API Help (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-Overview
-The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
-
-
-Package
-Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
-
-Interfaces (italic)
-Classes
-Enums
-Exceptions
-Errors
-Annotation Types
-
-
-
-Class/Interface
-Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
-
-Class inheritance diagram
-Direct Subclasses
-All Known Subinterfaces
-All Known Implementing Classes
-Class/interface declaration
-Class/interface description
-
-
-Nested Class Summary
-Field Summary
-Constructor Summary
-Method Summary
-
-
-Field Detail
-Constructor Detail
-Method Detail
-
-Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-Annotation Type
-Each annotation type has its own separate page with the following sections:
-
-Annotation Type declaration
-Annotation Type description
-Required Element Summary
-Optional Element Summary
-Element Detail
-
-
-
-Enum
-Each enum has its own separate page with the following sections:
-
-Enum declaration
-Enum description
-Enum Constant Summary
-Enum Constant Detail
-
-
-
-Tree (Class Hierarchy)
-There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
-
-When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
-When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
-
-
-
-Deprecated API
-The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
-
-
-Index
-The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
-
-
-Prev/Next
-These links take you to the next or previous class, interface, package, or related page.
-
-
-Frames/No Frames
-These links show and hide the HTML frames. All pages are available with or without frames.
-
-
-All Classes
-The All Classes link shows all classes and interfaces except non-static nested types.
-
-
-Serialized Form
-Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
-
-
-Constant Field Values
-The Constant Field Values page lists the static final fields and their values.
-
-
-
This help file applies to API documentation generated using the standard doclet. Index (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-A B C D E F G H I K L M N O P R S T U V W
-
-
-
A
-
-afterClose(Config, TaskContext) TaskLifecycleListener
-Called after all tasks in TaskRunner are closed.
-
-afterInit(Config, TaskContext) TaskLifecycleListener
-Called after all tasks in TaskRunner are initialized.
-
-afterProcess(IncomingMessageEnvelope, Config, TaskContext) TaskLifecycleListener
-Called after a message is processed by a task.
-
-ApplicationStatus org.apache.samza.job
-Status of a
StreamJob during and after its run.
-
-
-
-
-
B
-
-BaseMessageChooser org.apache.samza.system.chooser
-An abstract MessageChooser that implements start/stop/register for choosers
- that don't use them.
-
-BaseMessageChooser() BaseMessageChooser
-beforeClose(Config, TaskContext) TaskLifecycleListener
-Called before all tasks in TaskRunner are closed.
-
-beforeInit(Config, TaskContext) TaskLifecycleListener
-Called before all tasks in TaskRunner are initialized.
-
-beforeProcess(IncomingMessageEnvelope, Config, TaskContext) TaskLifecycleListener
-Called before a message is processed by a task.
-
-BLOCK_ON_OUTSTANDING_MESSAGES 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 org.apache.samza.util
-
- BlockingEnvelopeMap is a helper class for SystemConsumer implementations.
-
-BlockingEnvelopeMap() BlockingEnvelopeMap
-BlockingEnvelopeMap(Clock) BlockingEnvelopeMap
-BlockingEnvelopeMap(MetricsRegistry) BlockingEnvelopeMap
-BlockingEnvelopeMap(MetricsRegistry, Clock) BlockingEnvelopeMap
-BlockingEnvelopeMap(MetricsRegistry, Clock, String) BlockingEnvelopeMap
-BlockingEnvelopeMap.BlockingEnvelopeMapMetrics org.apache.samza.util
-BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(String, MetricsRegistry) BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-BlockingEnvelopeMap.BufferGauge org.apache.samza.util
-BlockingEnvelopeMap.BufferGauge(SystemStreamPartition, String) BlockingEnvelopeMap.BufferGauge
-buildCommand() CommandBuilder
-buildEnvironment() CommandBuilder
-
-
-
-
-
C
-
-Checkpoint 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>) Checkpoint
-Constructs a new checkpoint based off a map of Samza stream offsets.
-
-CheckpointManager org.apache.samza.checkpoint
-CheckpointManagers read and write
Checkpoint to some
- implementation-specific location.
-CheckpointManagerFactory org.apache.samza.checkpoint
-
-
-choose() MessageChooser
-The choose method is invoked when the SamzaContainer is ready to process a
- new message.
-
-clear() Config
-clear() Counter
-Clock org.apache.samza.util
-Mockable interface for tracking time.
-
-ClosableTask 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() ClosableTask
-CommandBuilder 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() CommandBuilder
-commit(TaskCoordinator.RequestScope) TaskCoordinator
-Requests that Samza should write out a checkpoint, from which a task can restart
- after failure.
-
-compareAndSet(T, T) Gauge
-compareTo(TaskName) TaskName
-compareTo(Partition) Partition
-compareTo(SystemStreamPartition) SystemStreamPartition
-Config org.apache.samza.config
-Store and retrieve named, typed values as configuration for classes implementing this interface.
-
-Config() Config
-config SamzaContainerContext
-config CommandBuilder
-ConfigException org.apache.samza.config
-
-
-ConfigException(Throwable) ConfigException
-ConfigException(String) ConfigException
-ConfigException(String, Throwable) ConfigException
-ConfigFactory org.apache.samza.config
-
-
-ConfigRewriter 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) MapConfig
-containsValue(Object) MapConfig
-Counter org.apache.samza.metrics
-A counter is a
Metric that represents a cumulative value.
-Counter(String) Counter
-counter(Counter) MetricsVisitor
-currentTimeMillis() Clock
-
-
-
-
-
D
-
-dec() Counter
-dec(long) Counter
-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.
-
-
-
-
-
-
E
-
-entrySet() MapConfig
-equals(Object) Checkpoint
-equals(Object) MapConfig
-equals(Object) TaskName
-equals(Object) Partition
-equals(Object) IncomingMessageEnvelope
-equals(Object) OutgoingMessageEnvelope
-equals(Object) SystemStream
-equals(Object) SystemStreamMetadata
-equals(Object) SystemStreamMetadata.SystemStreamPartitionMetadata
-equals(Object) SystemStreamPartition
-
-
-
-
-
F
-
-flush() StorageEngine
-Flush any cached messages
-
-flush(String) 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[]) 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) Gauge
-gauge(Gauge<T>) MetricsVisitor
-get(String, String) Config
-get(Object) MapConfig
-getAdmin(String, Config) SystemFactory
-getAverage() Snapshot
-Get the average of the values in the collection
-
-getBoolean(String, boolean) Config
-getBoolean(String) Config
-getCheckpointManager(Config, MetricsRegistry) CheckpointManagerFactory
-getChooser(Config, MetricsRegistry) MessageChooserFactory
-getClass(String) Config
-getConfig(URI) ConfigFactory
-Build a specific Config.
-
-getConsumer(String, Config, MetricsRegistry) SystemFactory
-getCount() Counter
-getDate(String) Config
-getDate(String, String) Config
-getDate(String, SimpleDateFormat) Config
-getDate(String, Date) Config
-getDate(String, String, Date) Config
-getDate(String, SimpleDateFormat, Date) Config
-getDouble(String, double) Config
-getDouble(String) Config
-getGroup(String) ReadableMetricsRegistry
-getGroups() ReadableMetricsRegistry
-getInt(String, int) Config
-getInt(String) Config
-getJob(Config) StreamJobFactory
-getKey() IncomingMessageEnvelope
-getKey() OutgoingMessageEnvelope
-getKeySerializerName() OutgoingMessageEnvelope
-getLifecyleListener(String, Config) TaskLifecycleListenerFactory
-getList(String, List<String>) Config
-getList(String) Config
-getLong(String, long) Config
-getLong(String) Config
-getMax() Snapshot
-Get the maximum value in the collection
-
-getMessage() IncomingMessageEnvelope
-getMessage() OutgoingMessageEnvelope
-getMessageSerializerName() OutgoingMessageEnvelope
-getMetricsRegistry() TaskContext
-getMetricsReporter(String, String, Config) MetricsReporterFactory
-getMin() Snapshot
-Get the minimum value in the collection
-
-getName() Counter
-getName() Gauge
-getName() Timer
-Get the name of the timer
-
-getNewestOffset() SystemStreamMetadata.SystemStreamPartitionMetadata
-getNewInstance(String) Config
-getNumMessagesInQueue(SystemStreamPartition) BlockingEnvelopeMap
-getOffset() IncomingMessageEnvelope
-getOffset(SystemStreamMetadata.OffsetType) SystemStreamMetadata.SystemStreamPartitionMetadata
-getOffsets() Checkpoint
-Gets a unmodifiable view of the current Samza stream offsets.
-
-getOffsetsAfter(Map<SystemStreamPartition, String>) SystemAdmin
-Fetches the offsets for the messages immediately after the supplied offsets
- for a group of SystemStreamPartitions.
-
-getOffsetsAfter(Map<SystemStreamPartition, String>) SinglePartitionWithoutOffsetsSystemAdmin
-getOldestOffset() SystemStreamMetadata.SystemStreamPartitionMetadata
-getPartition() SystemStreamPartition
-getPartitionId() Partition
-getPartitionKey() OutgoingMessageEnvelope
-getProducer(String, Config, MetricsRegistry) SystemFactory
-getSerde(String, Config) SerdeFactory
-getShort(String, short) Config
-getShort(String) Config
-getSize() Snapshot
-Get the number of values in the collection
-
-getSnapshot() Reservoir
-
-
-getSnapshot() SlidingTimeWindowReservoir
-getSnapshot() Timer
-
-
-getStatus() StreamJob
-
-
-getStorageEngine(String, File, Serde<K>, Serde<V>, MessageCollector, MetricsRegistry, SystemStreamPartition, SamzaContainerContext) StorageEngineFactory
-Create an instance of the given storage engine.
-
-getStore(String) TaskContext
-getStream() SystemStream
-getStreamName() SystemStreamMetadata
-getSystem() SystemStream
-getSystemStream() OutgoingMessageEnvelope
-getSystemStream() SystemStreamPartition
-getSystemStreamMetadata(Set<String>) SystemAdmin
-Fetch metadata from a system for a set of streams.
-
-getSystemStreamMetadata(Set<String>) SinglePartitionWithoutOffsetsSystemAdmin
-getSystemStreamPartition() IncomingMessageEnvelope
-getSystemStreamPartitionGrouper(Config) SystemStreamPartitionGrouperFactory
-getSystemStreamPartitionMetadata() SystemStreamMetadata
-getSystemStreamPartitions() TaskContext
-getTaskName() TaskName
-getTaskName() TaskContext
-getUpcomingOffset() SystemStreamMetadata.SystemStreamPartitionMetadata
-getValue() Gauge
-getValue() BlockingEnvelopeMap.BufferGauge
-getValues() Snapshot
-Return the entire list of values
-
-group(Set<SystemStreamPartition>) SystemStreamPartitionGrouper
-
-
-
-
-
H
-
-hash SystemStreamPartition
-hashCode() Checkpoint
-hashCode() MapConfig
-hashCode() TaskName
-hashCode() Partition
-hashCode() IncomingMessageEnvelope
-hashCode() OutgoingMessageEnvelope
-hashCode() SystemStream
-hashCode() SystemStreamMetadata
-hashCode() SystemStreamMetadata.SystemStreamPartitionMetadata
-hashCode() SystemStreamPartition
-hasNext() SystemStreamPartitionIterator
-
-
-
-
-
I
-
-inc() Counter
-inc(long) Counter
-incBlockingPoll(SystemStreamPartition) BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-incBlockingTimeoutPoll(SystemStreamPartition) BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-IncomingMessageEnvelope org.apache.samza.system
-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.
-
-IncomingMessageEnvelope(SystemStreamPartition, String, Object, Object) IncomingMessageEnvelope
-Constructs a new IncomingMessageEnvelope from specified components.
-
-incPoll() BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-init(Config, TaskContext) InitableTask
-Called by TaskRunner each time an implementing task is created.
-
-InitableTask 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) BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-isAtHead(SystemStreamPartition) BlockingEnvelopeMap
-isEmpty() MapConfig
-
-
-
-
-
K
-
-keySet() MapConfig
-kill() StreamJob
-Kill this job immediately.
-
-
-
-
-
-
L
-
-listen(ReadableMetricsRegistryListener) ReadableMetricsRegistry
-
-
-
-
-
M
-
-MapConfig org.apache.samza.config
-
-
-MapConfig() MapConfig
-MapConfig(Map<String, String>) MapConfig
-MapConfig(List<Map<String, String>>) MapConfig
-MessageChooser org.apache.samza.system.chooser
-MessageChooser is an interface for programmatic fine-grain control over
- stream consumption.
-
-MessageChooserFactory org.apache.samza.system.chooser
-
-
-MessageCollector org.apache.samza.task
-Used as an interface for the means of sending message envelopes to an output stream.
-
-Metric org.apache.samza.metrics
-Metric class that allows metric visitors to visit it to get its information.
-
-MetricsRegistry 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 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 org.apache.samza.metrics
-
-
-MetricsVisitor 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() MetricsVisitor
-
-
-
-
-
N
-
-name SamzaContainerContext
-name CommandBuilder
-newBlockingQueue() BlockingEnvelopeMap
-newCounter(String, String) MetricsRegistry
-
-
-newCounter(String, Counter) MetricsRegistry
-Register existing
Counter with this registry
-newCounter(String, String) NoOpMetricsRegistry
-newCounter(String, Counter) NoOpMetricsRegistry
-newGauge(String, String, T) MetricsRegistry
-Create and register a new
Gauge
-newGauge(String, Gauge<T>) MetricsRegistry
-Register an existing
Gauge
-newGauge(String, String, T) NoOpMetricsRegistry
-newGauge(String, Gauge<T>) NoOpMetricsRegistry
-newTimer(String, String) MetricsRegistry
-Create and Register a new
Timer
-newTimer(String, Timer) MetricsRegistry
-Register existing
Timer with this registry
-newTimer(String, String) NoOpMetricsRegistry
-newTimer(String, Timer) NoOpMetricsRegistry
-next() SystemStreamPartitionIterator
-NoOpMetricsRegistry org.apache.samza.util
-MetricsRegistry implementation for when no actual metrics need to be
- recorded but a registry is still required.
-NoOpMetricsRegistry() NoOpMetricsRegistry
-
-
-
-
-
O
-
-onCounter(String, Counter) ReadableMetricsRegistryListener
-onGauge(String, Gauge<?>) ReadableMetricsRegistryListener
-onTimer(String, Timer) ReadableMetricsRegistryListener
-org.apache.samza - package org.apache.samza
-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.serializers - package org.apache.samza.serializers
-org.apache.samza.storage - package org.apache.samza.storage
-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 org.apache.samza.system
-
-
-OutgoingMessageEnvelope(SystemStream, String, String, Object, Object, Object) OutgoingMessageEnvelope
-Constructs a new OutgoingMessageEnvelope from specified components.
-
-OutgoingMessageEnvelope(SystemStream, Object, Object, Object) OutgoingMessageEnvelope
-Constructs a new OutgoingMessageEnvelope from specified components.
-
-OutgoingMessageEnvelope(SystemStream, Object, Object) OutgoingMessageEnvelope
-Constructs a new OutgoingMessageEnvelope from specified components.
-
-OutgoingMessageEnvelope(SystemStream, Object) OutgoingMessageEnvelope
-Constructs a new OutgoingMessageEnvelope from specified components.
-
-
-
-
-
-
P
-
-Partition org.apache.samza
-A numbered, ordered partition of a stream.
-
-Partition(int) Partition
-Constructs a new Samza stream partition from a specified partition number.
-
-partition SystemStreamPartition
-poll(Set<SystemStreamPartition>, long) SystemConsumer
-Poll the SystemConsumer to get any available messages from the underlying
- system.
-
-poll(Set<SystemStreamPartition>, long) BlockingEnvelopeMap
-process(IncomingMessageEnvelope, MessageCollector, TaskCoordinator) StreamTask
-Called once for each message that this StreamTask receives.
-
-put(String, String) Config
-put(SystemStreamPartition, IncomingMessageEnvelope) BlockingEnvelopeMap
-putAll(Map<? extends String, ? extends String>) Config
-putAll(SystemStreamPartition, List<IncomingMessageEnvelope>) BlockingEnvelopeMap
-
-
-
-
-
R
-
-ReadableMetricsRegistry org.apache.samza.metrics
-A ReadableMetricsRegistry is a
MetricsRegistry that also
- allows read access to the metrics for which it is responsible.
-ReadableMetricsRegistryListener org.apache.samza.metrics
-readChangeLogPartitionMapping() CheckpointManager
-Read the taskName to partition mapping that is being maintained by this CheckpointManager
-
-readLastCheckpoint(TaskName) CheckpointManager
-Returns the last recorded checkpoint for a specified taskName.
-
-register(TaskName) CheckpointManager
-Registers this manager to write checkpoints of a specific Samza stream partition.
-
-register(String, ReadableMetricsRegistry) MetricsReporter
-register(SystemStreamPartition, String) BaseMessageChooser
-register(SystemStreamPartition, String) MessageChooser
-Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition.
-
-register(SystemStreamPartition, String) SystemConsumer
-Register a SystemStreamPartition to this SystemConsumer.
-
-register(String) SystemProducer
-Registers this producer to send messages from a specified Samza source, such as a StreamTask.
-
-register(SystemStreamPartition, String) BlockingEnvelopeMap
-remove(Object) Config
-remove() SystemStreamPartitionIterator
-Reservoir org.apache.samza.metrics
-A reservoir interface to store, update and display values
-
-restore(Iterator<IncomingMessageEnvelope>) StorageEngine
-Restore the content of this StorageEngine from the changelog.
-
-rewrite(String, Config) ConfigRewriter
-
-
-
-
-
S
-
-SamzaContainerContext org.apache.samza.container
-A SamzaContainerContext maintains per-container information for the tasks it executes.
-
-SamzaContainerContext(String, Config, Collection<TaskName>) SamzaContainerContext
-An immutable context object that can passed to tasks to give them information
- about the container in which they are executing.
-
-SamzaException org.apache.samza
-Unchecked exception that Samza throws when something goes wrong.
-
-SamzaException() SamzaException
-SamzaException(String, Throwable) SamzaException
-SamzaException(String) SamzaException
-SamzaException(Throwable) SamzaException
-send(String, OutgoingMessageEnvelope) SystemProducer
-Sends a specified message envelope from a specified Samza source.
-
-send(OutgoingMessageEnvelope) MessageCollector
-Sends message envelope out onto specified stream.
-
-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) Counter
-set(T) Gauge
-setConfig(Config) CommandBuilder
-setIsAtHead(SystemStreamPartition, boolean) BlockingEnvelopeMap
-setName(String) CommandBuilder
-setNoMoreMessages(SystemStreamPartition, boolean) BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-setTaskNameToChangeLogPartitionMapping(Map<TaskName, Integer>) CommandBuilder
-setTaskNameToSystemStreamPartitionsMapping(Map<TaskName, Set<SystemStreamPartition>>) CommandBuilder
-shutdown(TaskCoordinator.RequestScope) TaskCoordinator
-Requests that the container should be shut down.
-
-SinglePartitionWithoutOffsetsSystemAdmin org.apache.samza.util
-A simple helper admin class that defines a single partition (partition 0) for
- a given system.
-
-SinglePartitionWithoutOffsetsSystemAdmin() SinglePartitionWithoutOffsetsSystemAdmin
-size() MapConfig
-size() Reservoir
-Return the number of values in this reservoir
-
-size() SlidingTimeWindowReservoir
-SlidingTimeWindowReservoir org.apache.samza.metrics
-An implemented
Reservoir used to store values that appear in a
- sliding time window
-SlidingTimeWindowReservoir() SlidingTimeWindowReservoir
-Default constructor using default window size
-
-SlidingTimeWindowReservoir(long) SlidingTimeWindowReservoir
-Construct the SlidingTimeWindowReservoir with window size
-
-SlidingTimeWindowReservoir(long, Clock) SlidingTimeWindowReservoir
-Snapshot org.apache.samza.metrics
-A statistical snapshot of a collection of values
-
-Snapshot(Collection<Long>) Snapshot
-start() CheckpointManager
-start() MetricsReporter
-start() BaseMessageChooser
-start() MessageChooser
-Called after all SystemStreamPartitions have been registered.
-
-start() SystemConsumer
-Tells the SystemConsumer to connect to the underlying system, and prepare
- to begin serving messages when poll is invoked.
-
-start() SystemProducer
-Start the SystemProducer.
-
-stop() CheckpointManager
-stop() MetricsReporter
-stop() StorageEngine
-Close the storage engine
-
-stop() BaseMessageChooser
-stop() MessageChooser
-Called when the chooser is about to be discarded.
-
-stop() SystemConsumer
-Tells the SystemConsumer to close all connections, release all resource,
- and shut down everything.
-
-stop() SystemProducer
-Stop the SystemProducer.
-
-StorageEngine 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.
-
-stream SystemStream
-StreamJob org.apache.samza.job
-A StreamJob runs Samza
StreamTasks in its specific environment.
-StreamJobFactory org.apache.samza.job
-
-
-StreamTask org.apache.samza.task
-A StreamTask is the basic class on which Samza jobs are implemented.
-
-submit() StreamJob
-Submit this job to be run.
-
-subset(String) Config
-subset(String, boolean) Config
-system SystemStream
-SystemAdmin org.apache.samza.system
-Helper interface attached to an underlying system to fetch
- information about streams, partitions, offsets, etc.
-
-SystemConsumer org.apache.samza.system
-
- SystemConsumer is the interface that must be implemented by any system that
- wishes to integrate with Samza.
-
-SystemFactory org.apache.samza.system
-
-
-SystemProducer 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 org.apache.samza.system
-Streams in Samza consist of both the stream name and the system to which the stream belongs.
-
-SystemStream(String, String) SystemStream
-Constructs a Samza stream object from specified components.
-
-SystemStream(SystemStream) SystemStream
-Constructs a Samza stream object based upon an existing Samza stream.
-
-SystemStreamMetadata 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>) SystemStreamMetadata
-SystemStreamMetadata.OffsetType 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 org.apache.samza.system
-Provides offset information for a given SystemStreamPartition.
-
-SystemStreamMetadata.SystemStreamPartitionMetadata(String, String, String) SystemStreamMetadata.SystemStreamPartitionMetadata
-SystemStreamPartition org.apache.samza.system
-
-
-SystemStreamPartition(String, String, Partition) SystemStreamPartition
-Constructs a Samza stream partition object from specified components.
-
-SystemStreamPartition(SystemStreamPartition) SystemStreamPartition
-Constructs a Samza stream partition object based upon an existing Samza stream partition.
-
-SystemStreamPartition(SystemStream, Partition) SystemStreamPartition
-Constructs a Samza stream partition object based upon another Samza stream and a specified partition.
-
-SystemStreamPartitionGrouper org.apache.samza.container.grouper.stream
-Group a set of SystemStreamPartitions into logical taskNames that share a common characteristic, defined
- by the implementation.
-
-SystemStreamPartitionGrouperFactory org.apache.samza.container.grouper.stream
-Return an instance a SystemStreamPartitionGrouper per the particular implementation
-
-SystemStreamPartitionIterator org.apache.samza.system
-
-
-SystemStreamPartitionIterator(SystemConsumer, SystemStreamPartition) SystemStreamPartitionIterator
-SystemStreamPartitionIterator(SystemConsumer, SystemStreamPartition, int) SystemStreamPartitionIterator
-
-
-
-
-
T
-
-TaskContext org.apache.samza.task
-
-
-TaskCoordinator 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
CheckpointManagers or shutting down the task or all tasks within
- a container.
-TaskCoordinator.RequestScope org.apache.samza.task
-
-
-TaskLifecycleListener org.apache.samza.task
-Used to get before/after notifications before initializing/closing all tasks
- in a given container (JVM/process).
-
-TaskLifecycleListenerFactory org.apache.samza.task
-
-
-TaskName org.apache.samza.container
-
-
-TaskName(String) TaskName
-taskNames SamzaContainerContext
-taskNameToChangeLogPartitionMapping CommandBuilder
-taskNameToSystemStreamPartitionsMapping CommandBuilder
-timer(Timer) MetricsVisitor
-Timer org.apache.samza.metrics
-A timer metric that stores time duration and provides
Snapshot of the
- durations.
-Timer(String) Timer
-Default constructor.
-
-Timer(String, long, Clock) Timer
-Construct a
Timer with given window size
-Timer(String, Reservoir) Timer
-
-
-toBytes(T) Serializer
-Serializes given object to an array of bytes.
-
-toString() Checkpoint
-toString() MapConfig
-toString() TaskName
-toString() ApplicationStatus
-toString() Counter
-toString() Gauge
-toString() Partition
-toString() IncomingMessageEnvelope
-toString() OutgoingMessageEnvelope
-toString() SystemStream
-toString() SystemStreamMetadata.SystemStreamPartitionMetadata
-toString() SystemStreamMetadata
-toString() SystemStreamPartition
-
-
-
-
-
U
-
-unlisten(ReadableMetricsRegistryListener) ReadableMetricsRegistry
-update(long) Reservoir
-Update the reservoir with the new value
-
-update(long) SlidingTimeWindowReservoir
-update(long) Timer
-Add the time duration
-
-update(IncomingMessageEnvelope) MessageChooser
-Notify the chooser that a new envelope is available for a processing.
-
-
-
-
-
-
V
-
-valueOf(String) ApplicationStatus
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) SystemStreamMetadata.OffsetType
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) TaskCoordinator.RequestScope
-Returns the enum constant of this type with the specified name.
-
-values() MapConfig
-values() ApplicationStatus
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() SystemStreamMetadata.OffsetType
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() TaskCoordinator.RequestScope
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-visit(MetricsVisitor) Counter
-visit(MetricsVisitor) Gauge
-visit(MetricsVisitor) Metric
-visit(Metric) MetricsVisitor
-visit(MetricsVisitor) Timer
-
-
-
-
-
W
-
-waitForFinish(long) StreamJob
-Block on this job until either it finishes or reaches its timeout value
-
-waitForStatus(ApplicationStatus, long) StreamJob
-Block on this job until either it transitions to the specified status or reaches it timeout value
-
-window(MessageCollector, TaskCoordinator) WindowableTask
-Called by TaskRunner for each implementing task at the end of every specified window.
-
-WindowableTask org.apache.samza.task
-Add-on interface to
StreamTask implementations to add code which will be run on
- a specified time interval (via configuration).
-writeChangeLogPartitionMapping(Map<TaskName, Integer>) CheckpointManager
-Write the taskName to partition mapping that is being maintained by this CheckpointManager
-
-writeCheckpoint(TaskName, Checkpoint) CheckpointManager
-Writes a checkpoint based on the current state of a Samza stream partition.
-
-
-
A B C D E F G H I K L M N O P R S T U V W samza-api 0.8.0-SNAPSHOT API
-
-
-
-
-
-<![CDATA[
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
-<h2>Frame Alert</h2>
-<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p>
-]]>
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/Partition.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/Partition.html
deleted file mode 100644
index a62d4a871725c812f5306bb40fe20f5981c9cc69..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/Partition.html
+++ /dev/null
@@ -1,332 +0,0 @@
-
-
-
-
-
-Partition (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.Partition
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.lang.Comparable<Partition >
-
-public class Partition
-extends java.lang.Object
-implements java.lang.Comparable<Partition >
-A numbered, ordered partition of a stream.
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Partition Constructs a new Samza stream partition from a specified partition number.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
SamzaException (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-org.apache.samza.SamzaException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-SamzaException
-public SamzaException()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
- Checkpoint (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.checkpoint.Checkpoint
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Checkpoint SystemStreamPartition ,java.lang.String> offsets)Constructs a new checkpoint based off a map of Samza stream offsets.
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals
-
-java.util.Map<SystemStreamPartition ,java.lang.String>getOffsets Gets a unmodifiable view of the current Samza stream offsets.
-
-
-inthashCode
-
-java.lang.StringtoString
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-Checkpoint
-public Checkpoint(java.util.Map<SystemStreamPartition ,java.lang.String> offsets)
-Constructs a new checkpoint based off a map of Samza stream offsets.
-Parameters: offsets - Map of Samza streams to their current offset.
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getOffsets
-public java.util.Map<SystemStreamPartition ,java.lang.String> getOffsets()
-Gets a unmodifiable view of the current Samza stream offsets.
-Returns: A unmodifiable view of a Map of Samza streams to their recorded offsets.
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
CheckpointManager (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-java.util.Map<TaskName ,java.lang.Integer>readChangeLogPartitionMapping Read the taskName to partition mapping that is being maintained by this CheckpointManager
-
-
-Checkpoint readLastCheckpoint TaskName taskName)Returns the last recorded checkpoint for a specified taskName.
-
-
-voidregister TaskName taskName)Registers this manager to write checkpoints of a specific Samza stream partition.
-
-
-voidstart
-
-voidstop
-
-voidwriteChangeLogPartitionMapping TaskName ,java.lang.Integer> mapping)Write the taskName to partition mapping that is being maintained by this CheckpointManager
-
-
-voidwriteCheckpoint TaskName taskName,
- Checkpoint checkpoint)Writes a checkpoint based on the current state of a Samza stream partition.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-start
-void start()
-
-
-
-
-
-
-
-
-
-
-
-writeCheckpoint
-void writeCheckpoint(TaskName taskName,
- Checkpoint checkpoint)
-Writes a checkpoint based on the current state of a Samza stream partition.
-Parameters: taskName - Specific Samza taskName of which to write a checkpoint of.checkpoint - Reference to a Checkpoint object to store offset data in.
-
-
-
-
-
-
-
-
-
-
-readChangeLogPartitionMapping
-java.util.Map<TaskName ,java.lang.Integer> readChangeLogPartitionMapping()
-Read the taskName to partition mapping that is being maintained by this CheckpointManager
-Returns: TaskName to task log partition mapping, or an empty map if there were no messages.
-
-
-
-
-
-
-writeChangeLogPartitionMapping
-void writeChangeLogPartitionMapping(java.util.Map<TaskName ,java.lang.Integer> mapping)
-Write the taskName to partition mapping that is being maintained by this CheckpointManager
-Parameters: mapping - Each TaskName's partition within the changelog
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- CheckpointManagerFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.checkpoint (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
org.apache.samza.checkpoint (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-Checkpoint
-A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each.
-
-
-
-
-
-
-
org.apache.samza.checkpoint Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Config (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.config.Config
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.util.Map<java.lang.String,java.lang.String>
-
-
-Direct Known Subclasses:
-MapConfig
-public abstract class Config
-extends java.lang.Object
-implements java.util.Map<java.lang.String,java.lang.String>
-Store and retrieve named, typed values as configuration for classes implementing this interface.
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-Nested classes/interfaces inherited from interface java.util.Map
-java.util.Map.Entry<K,V>
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Config
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidclear
-
-java.lang.Stringget
-
-booleangetBoolean
-
-booleangetBoolean
-
-<T> java.lang.Class<T>getClass
-
-java.util.DategetDate
-
-java.util.DategetDate
-
-java.util.DategetDate
-
-java.util.DategetDate
-
-java.util.DategetDate
-
-java.util.DategetDate
-
-doublegetDouble
-
-doublegetDouble
-
-intgetInt
-
-intgetInt
-
-java.util.List<java.lang.String>getList
-
-java.util.List<java.lang.String>getList
-
-longgetLong
-
-longgetLong
-
-<T> TgetNewInstance
-
-shortgetShort
-
-shortgetShort
-
-java.lang.Stringput
-
-voidputAll
-
-java.lang.Stringremove
-
-Config subset
-
-Config subset
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.util.Map
-containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, size, values
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-Config
-public Config()
-
-
-
-
-
-
-
-
-
ConfigException (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
- ConfigFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Config getConfig Build a specific Config.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- ConfigRewriter (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-public interface 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.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Config rewrite Config config)
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MapConfig (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-Nested classes/interfaces inherited from interface java.util.Map
-java.util.Map.Entry<K,V>
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-MapConfig
-
-MapConfig
-
-MapConfig
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-booleancontainsKey
-
-booleancontainsValue
-
-java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>entrySet
-
-booleanequals
-
-java.lang.Stringget
-
-inthashCode
-
-booleanisEmpty
-
-java.util.Set<java.lang.String>keySet
-
-intsize
-
-java.lang.StringtoString
-
-java.util.Collection<java.lang.String>values
-
-
-
-
-
-Methods inherited from class org.apache.samza.config.Config
-clear , get , getBoolean , getBoolean , getClass , getDate , getDate , getDate , getDate , getDate , getDate , getDouble , getDouble , getInt , getInt , getList , getList , getLong , getLong , getNewInstance , getShort , getShort , put , putAll , remove , subset , subset
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-MapConfig
-public MapConfig()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isEmpty
-public boolean isEmpty()
-
-
-
-
-
-
-
-
-
-
-
-size
-public int size()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Specified by: hashCode in interface java.util.Map<java.lang.String,java.lang.String>Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
org.apache.samza.config (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
Exceptions
-
-
org.apache.samza.config (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-ConfigFactory
-
-
-
-
-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.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-Config
-Store and retrieve named, typed values as configuration for classes implementing this interface.
-
-
-
-MapConfig
-
-
-
-
-
-
-
-
-Exception Summary
-Exception
-Description
-
-
-
-ConfigException
-
-
-
-
-
-
-
-
org.apache.samza.config Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-java.lang.Object
-
-org.apache.samza.config.Config
-java.lang.Throwable (implements java.io.Serializable)
-
-java.lang.Exception
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
Interface Hierarchy
-
-
SamzaContainerContext (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.container.SamzaContainerContext
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-SamzaContainerContext Config config,
- java.util.Collection<TaskName > taskNames)An immutable context object that can passed to tasks to give them information
- about the container in which they are executing.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-SamzaContainerContext
-public SamzaContainerContext(java.lang.String name,
- Config config,
- java.util.Collection<TaskName > taskNames)
-An immutable context object that can passed to tasks to give them information
- about the container in which they are executing.
-Parameters: name - The name of the container (either a YARN AM or SamzaContainer).config - The job configuration.taskNames - The set of taskName keys for which this container is responsible.
-
-
-
-
-
-
TaskName (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.container.TaskName
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-TaskName
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
SystemStreamPartitionGrouper (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-public interface SystemStreamPartitionGrouper
-Group a set of SystemStreamPartitions into logical taskNames that share a common characteristic, defined
- by the implementation. Each taskName has a key that uniquely describes what sets may be in it, but does
- not generally enumerate the elements of those sets. For example, a SystemStreamPartitionGrouper that
- groups SystemStreamPartitions (each with 4 partitions) by their partition, would end up generating
- four TaskNames: 0, 1, 2, 3. These TaskNames describe the partitions but do not list all of the
- SystemStreamPartitions, which allows new SystemStreamPartitions to be added later without changing
- the definition of the TaskNames, assuming these new SystemStreamPartitions do not have more than
- four partitions. On the other hand, a SystemStreamPartitionGrouper that wanted each SystemStreamPartition
- to be its own, unique group would use the SystemStreamPartition's entire description to generate
- the TaskNames.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SystemStreamPartitionGrouperFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.container.grouper.stream (samza-api 0.8.0-SNAPSHOT API)
-org.apache.samza.container.grouper.stream (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-SystemStreamPartitionGrouper
-Group a set of SystemStreamPartitions into logical taskNames that share a common characteristic, defined
- by the implementation.
-
-
-
-SystemStreamPartitionGrouperFactory
-Return an instance a SystemStreamPartitionGrouper per the particular implementation
-
-
-
-
-
-
-
org.apache.samza.container.grouper.stream Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/container/package-frame.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/container/package-frame.html
deleted file mode 100644
index 0de927281b167c5ed5dcb9cbe91e40bc5ee044b3..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/container/package-frame.html
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-
-
-
-org.apache.samza.container (samza-api 0.8.0-SNAPSHOT API)
-org.apache.samza.container (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-SamzaContainerContext
-A SamzaContainerContext maintains per-container information for the tasks it executes.
-
-
-
-TaskName
-
-
-
-
-
-
-
-
org.apache.samza.container Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/job/ApplicationStatus.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/job/ApplicationStatus.html
deleted file mode 100644
index d95bd40254b0f28360f4cabc9bc4692c413a2b12..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/job/ApplicationStatus.html
+++ /dev/null
@@ -1,359 +0,0 @@
-
-
-
-
-
-ApplicationStatus (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.StringtoString
-
-static ApplicationStatus valueOf Returns the enum constant of this type with the specified name.
-
-
-static ApplicationStatus []values Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static ApplicationStatus valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-
-
-
CommandBuilder (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.job.CommandBuilder
-
-
-
-
-
-
-public abstract class CommandBuilder
-extends java.lang.Object
-CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework,
- such as YARN or the LocalJobRunner.
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-CommandBuilder
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-CommandBuilder
-public CommandBuilder()
-
-
-
-
-
-
-
-
-
StreamJob (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-waitForStatus
-ApplicationStatus waitForStatus(ApplicationStatus status,
- long timeoutMs)Block on this job until either it transitions to the specified status or reaches it timeout value
-Parameters: status - Target ApplicationStatustimeoutMs - How many milliseconds to wait before returning, assuming the job has not transitioned to the specified valueReturns: ApplicationStatus
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- StreamJobFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.job (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.apache.samza.job (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-CommandBuilder
-CommandBuilders are used to customize the command necessary to launch a Samza Job for a particular framework,
- such as YARN or the LocalJobRunner.
-
-
-
-
-
-
-
-
-
-
org.apache.samza.job Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
Counter (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.metrics.Counter
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Counter
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-inc
-public long inc()
-
-
-
-
-
-
-
-inc
-public long inc(long n)
-
-
-
-
-
-
-
-dec
-public long dec()
-
-
-
-
-
-
-
-dec
-public long dec(long n)
-
-
-
-
-
-
-
-set
-public void set(long n)
-
-
-
-
-
-
-
-clear
-public void clear()
-
-
-
-
-
-
-
-getCount
-public long getCount()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Gauge (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.metrics.Gauge<T>
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Gauge T value)
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
Metric (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidvisit MetricsVisitor visitor)
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MetricsRegistry (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Counter newCounter Counter counter)Register existing
Counter with this registry
-
-Counter newCounter
-
-<T> Gauge <T>newGauge Gauge <T> value)Register an existing
Gauge
-
-<T> Gauge <T>newGauge Create and register a new
Gauge
-
-Timer newTimer Create and Register a new
Timer
-
-Timer newTimer Timer timer)Register existing
Timer with this registry
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MetricsReporter (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-public interface MetricsReporter
-A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive
- metrics from the Samza framework and Samza jobs.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-start
-void start()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MetricsReporterFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MetricsVisitor (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.metrics.MetricsVisitor
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-MetricsVisitor
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-MetricsVisitor
-public MetricsVisitor()
-
-
-
-
-
-
-
-
-
ReadableMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- ReadableMetricsRegistryListener (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidonCounter Counter counter)
-
-voidonGauge Gauge <?> gauge)
-
-voidonTimer Timer timer)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- Reservoir (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Snapshot getSnapshot
-
-intsize Return the number of values in this reservoir
-
-
-voidupdate Update the reservoir with the new value
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-getSnapshot
-Snapshot getSnapshot()Returns: a statistical snapshot of this reservoir
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SlidingTimeWindowReservoir (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.metrics.SlidingTimeWindowReservoir
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Snapshot getSnapshot
-
-intsize Return the number of values in this reservoir
-
-
-voidupdate Update the reservoir with the new value
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
Snapshot (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.metrics.Snapshot
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Snapshot
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-doublegetAverage Get the average of the values in the collection
-
-
-longgetMax Get the maximum value in the collection
-
-
-longgetMin Get the minimum value in the collection
-
-
-intgetSize Get the number of values in the collection
-
-
-java.util.ArrayList<java.lang.Long>getValues Return the entire list of values
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
Timer (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.metrics.Timer
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Timer Default constructor.
-
-
-Timer Clock clock)Construct a
Timer with given window size
-
-Timer Reservoir reservoir)
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-Metric
-Metric class that allows metric visitors to visit it to get its information.
-
-
-
-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.
-
-
-MetricsReporter
-A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive
- metrics from the Samza framework and Samza jobs.
-
-
-
-MetricsReporterFactory
-
-
-
-
-ReadableMetricsRegistry
-A ReadableMetricsRegistry is a
MetricsRegistry that also
- allows read access to the metrics for which it is responsible.
-
-
-ReadableMetricsRegistryListener
-
-
-Reservoir
-A reservoir interface to store, update and display values
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-Counter
-A counter is a
Metric that represents a cumulative value.
-
-
-Gauge <T>
-A Gauge is a
Metric that wraps some instance of T in a thread-safe
- reference and allows it to be set or retrieved.
-
-
-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.
-
-
-SlidingTimeWindowReservoir
-An implemented
Reservoir used to store values that appear in a
- sliding time window
-
-
-Snapshot
-A statistical snapshot of a collection of values
-
-
-
-Timer
-A timer metric that stores time duration and provides
Snapshot of the
- durations.
-
-
-
-
-
-
org.apache.samza.metrics Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
org.apache.samza (samza-api 0.8.0-SNAPSHOT API)
-
-
Classes
-
-
Exceptions
-
-
org.apache.samza (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-Partition
-A numbered, ordered partition of a stream.
-
-
-
-
-
-
-
-Exception Summary
-Exception
-Description
-
-
-
-SamzaException
-Unchecked exception that Samza throws when something goes wrong.
-
-
-
-
-
-
-
org.apache.samza Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-java.lang.Object
-
-org.apache.samza.Partition
-java.lang.Throwable (implements java.io.Serializable)
-
-java.lang.Exception
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
Deserializer (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-Type Parameters: T - The type of serialized object implementations can read
-All Known Subinterfaces:
-Serde <T>
-public interface Deserializer<T>
-A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their
- original form.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-T fromBytes Deserializes given serialized object from an array of bytes to its original form.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- Serde (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
- SerdeFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Serde <T >getSerde Config config)
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- Serializer (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-Type Parameters: T - The type of serialized object implementations can write
-All Known Subinterfaces:
-Serde <T>
-public interface Serializer<T>
-A standard interface for Samza compatible serializers, used for serializing objects to bytes.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-byte[]toBytes T object)Serializes given object to an array of bytes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)
-org.apache.samza.serializers (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-Deserializer <T>
-A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their
- original form.
-
-
-
-Serde <T>
-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>
-Build an instance of
Serde
-
-
-Serializer <T>
-A standard interface for Samza compatible serializers, used for serializing objects to bytes.
-
-
-
-
-
-
-
org.apache.samza.serializers Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Interface Hierarchy
-
-org.apache.samza.serializers.Deserializer
-org.apache.samza.serializers.Serde Serializer <T>)
-
-
-org.apache.samza.serializers.SerdeFactory
-org.apache.samza.serializers.Serializer
-org.apache.samza.serializers.Serde Deserializer <T>)
-
-
-
-
StorageEngine (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidflush Flush any cached messages
-
-
-voidrestore IncomingMessageEnvelope > envelopes)Restore the content of this StorageEngine from the changelog.
-
-
-voidstop Close the storage engine
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-restore
-void restore(java.util.Iterator<IncomingMessageEnvelope > envelopes)
-Restore the content of this StorageEngine from the changelog. Messages are
- provided in one Iterator and not deserialized for
- efficiency, allowing the implementation to optimize replay, if possible.
-Parameters: envelopes - An iterator of envelopes that the storage engine can read from to
- restore its state on startup.
-
-
-
-
-
-
-
-
-
-
-stop
-void stop()
-Close the storage engine
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- StorageEngineFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-public interface StorageEngineFactory<K,V>
-An object provided by the storage engine implementation to create instances
- of the given storage engine type.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getStorageEngine
-StorageEngine getStorageEngine(java.lang.String storeName,
- java.io.File storeDir,
- Serde <K > keySerde,
- Serde <V > msgSerde,
- MessageCollector collector,
- MetricsRegistry registry,
- SystemStreamPartition changeLogSystemStreamPartition,
- SamzaContainerContext containerContext)Create an instance of the given storage engine.
-Parameters: storeName - The name of the storage engine.storeDir - The directory of the storage engine.keySerde - The serializer to use for serializing keys when reading or writing to the store.msgSerde - The serializer to use for serializing messages when reading or writing to the store.collector - MessageCollector the storage engine uses to persist changes.registry - MetricsRegistry to which to publish storage-engine specific metrics.changeLogSystemStreamPartition - Samza stream partition from which to receive the changelog.containerContext - Information about the container in which the task is executing.Returns: The storage engine instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)
-org.apache.samza.storage (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-StorageEngine
-A storage engine for managing state maintained by a stream processor.
-
-
-
-StorageEngineFactory <K,V>
-An object provided by the storage engine implementation to create instances
- of the given storage engine type.
-
-
-
-
-
-
-
org.apache.samza.storage Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html
deleted file mode 100644
index c963f837d4c3c7026377348e17d0bf6ecac7360f..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/system/IncomingMessageEnvelope.html
+++ /dev/null
@@ -1,357 +0,0 @@
-
-
-
-
-
-IncomingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.IncomingMessageEnvelope
-
-
-
-
-
-
-public class IncomingMessageEnvelope
-extends java.lang.Object
-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.
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-IncomingMessageEnvelope SystemStreamPartition systemStreamPartition,
- java.lang.String offset,
- java.lang.Object key,
- java.lang.Object message)Constructs a new IncomingMessageEnvelope from specified components.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-IncomingMessageEnvelope
-public IncomingMessageEnvelope(SystemStreamPartition systemStreamPartition,
- java.lang.String offset,
- java.lang.Object key,
- java.lang.Object message)
-Constructs a new IncomingMessageEnvelope from specified components.
-Parameters: systemStreamPartition - The aggregate object representing the incoming stream name, the name of the cluster
- from which the stream came, and the partition of the stream from which the message was received.offset - The offset in the partition that the message was received from.key - A deserialized key received from the partition offset.message - A deserialized message received from the partition offset.
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.OutgoingMessageEnvelope
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-OutgoingMessageEnvelope SystemStream systemStream,
- java.lang.Object message)Constructs a new OutgoingMessageEnvelope from specified components.
-
-
-OutgoingMessageEnvelope SystemStream systemStream,
- java.lang.Object key,
- java.lang.Object message)Constructs a new OutgoingMessageEnvelope from specified components.
-
-
-OutgoingMessageEnvelope SystemStream systemStream,
- java.lang.Object partitionKey,
- java.lang.Object key,
- java.lang.Object message)Constructs a new OutgoingMessageEnvelope from specified components.
-
-
-OutgoingMessageEnvelope SystemStream systemStream,
- java.lang.String keySerializerName,
- java.lang.String messageSerializerName,
- java.lang.Object partitionKey,
- java.lang.Object key,
- java.lang.Object message)Constructs a new OutgoingMessageEnvelope from specified components.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-OutgoingMessageEnvelope
-public OutgoingMessageEnvelope(SystemStream systemStream,
- java.lang.String keySerializerName,
- java.lang.String messageSerializerName,
- java.lang.Object partitionKey,
- java.lang.Object key,
- java.lang.Object message)
-Constructs a new OutgoingMessageEnvelope from specified components.
-Parameters: systemStream - Object representing the appropriate stream of which this envelope will be sent on.keySerializerName - String representing the serializer used for serializing this envelope's key.messageSerializerName - String representing the serializer used for serializing this envelope's message.partitionKey - A key representing which partition of the systemStream to send this envelope on.key - A deserialized key to be used for the message.message - A deserialized message to be sent in this envelope.
-
-
-
-
-
-
-OutgoingMessageEnvelope
-public OutgoingMessageEnvelope(SystemStream systemStream,
- java.lang.Object partitionKey,
- java.lang.Object key,
- java.lang.Object message)
-Constructs a new OutgoingMessageEnvelope from specified components.
-Parameters: systemStream - Object representing the appropriate stream of which this envelope will be sent on.partitionKey - A key representing which partition of the systemStream to send this envelope on.key - A deserialized key to be used for the message.message - A deserialized message to be sent in this envelope.
-
-
-
-
-
-
-OutgoingMessageEnvelope
-public OutgoingMessageEnvelope(SystemStream systemStream,
- java.lang.Object key,
- java.lang.Object message)
-Constructs a new OutgoingMessageEnvelope from specified components.
-Parameters: systemStream - Object representing the appropriate stream of which this envelope will be sent on.key - A deserialized key to be used for the message.message - A deserialized message to be sent in this envelope.
-
-
-
-
-
-
-OutgoingMessageEnvelope
-public OutgoingMessageEnvelope(SystemStream systemStream,
- java.lang.Object message)
-Constructs a new OutgoingMessageEnvelope from specified components.
-Parameters: systemStream - Object representing the appropriate stream of which this envelope will be sent on.message - A deserialized message to be sent in this envelope.
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
SystemAdmin (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-All Known Implementing Classes:
-SinglePartitionWithoutOffsetsSystemAdmin
-public interface SystemAdmin
-Helper interface attached to an underlying system to fetch
- information about streams, partitions, offsets, etc. This interface is useful
- for providing utility methods that Samza needs in order to interact with a
- system.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getOffsetsAfter
-java.util.Map<SystemStreamPartition ,java.lang.String> getOffsetsAfter(java.util.Map<SystemStreamPartition ,java.lang.String> offsets)
-Fetches the offsets for the messages immediately after the supplied offsets
- for a group of SystemStreamPartitions.
-Parameters: offsets - Map from SystemStreamPartition to current offsets.Returns: Map from SystemStreamPartition to offsets immediately after the
- current offsets.
-
-
-
-
-
-
-getSystemStreamMetadata
-java.util.Map<java.lang.String,SystemStreamMetadata > getSystemStreamMetadata(java.util.Set<java.lang.String> streamNames)
-Fetch metadata from a system for a set of streams.
-Parameters: streamNames - The streams to to fetch metadata for.Returns: A map from stream name to SystemStreamMetadata for each stream
- requested in the parameter set.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SystemConsumer (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static intBLOCK_ON_OUTSTANDING_MESSAGES 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).
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-java.util.Map<SystemStreamPartition ,java.util.List<IncomingMessageEnvelope >>poll SystemStreamPartition > systemStreamPartitions,
- long timeout)Poll the SystemConsumer to get any available messages from the underlying
- system.
-
-
-voidregister SystemStreamPartition systemStreamPartition,
- java.lang.String offset)Register a SystemStreamPartition to this SystemConsumer.
-
-
-voidstart Tells the SystemConsumer to connect to the underlying system, and prepare
- to begin serving messages when poll is invoked.
-
-
-voidstop Tells the SystemConsumer to close all connections, release all resource,
- and shut down everything.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-BLOCK_ON_OUTSTANDING_MESSAGES
-static final int BLOCK_ON_OUTSTANDING_MESSAGES
-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).
-See Also: Constant Field Values
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-register
-void register(SystemStreamPartition systemStreamPartition,
- java.lang.String offset)
-Register a SystemStreamPartition to this SystemConsumer. The SystemConsumer
- should try and read messages from all SystemStreamPartitions that are
- registered to it. SystemStreamPartitions should only be registered before
- start is called.
-Parameters: systemStreamPartition - The SystemStreamPartition object representing the Samza
- SystemStreamPartition to receive messages from.offset - String representing the offset of the point in the stream to start
- reading messages from. This is an inclusive parameter; if "7" were
- specified, the first message for the system/stream/partition to be
- consumed and returned would be a message whose offset is "7".
-
-
-
-
-
-
-
-
-
-
SystemFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SystemProducer (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidflush 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.
-
-
-voidregister Registers this producer to send messages from a specified Samza source, such as a StreamTask.
-
-
-voidsend OutgoingMessageEnvelope envelope)Sends a specified message envelope from a specified Samza source.
-
-
-voidstart Start the SystemProducer.
-
-
-voidstop Stop the SystemProducer.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-register
-void register(java.lang.String source)
-Registers this producer to send messages from a specified Samza source, such as a StreamTask.
-Parameters: source - String representing the source of the message.
-
-
-
-
-
-
-send
-void send(java.lang.String source,
- OutgoingMessageEnvelope envelope)
-Sends a specified message envelope from a specified Samza source.
-Parameters: source - String representing the source of the message.envelope - Aggregate object representing the serialized message to send from the source.
-
-
-
-
-
-
-flush
-void flush(java.lang.String source)
-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.
-Parameters: source - String representing the source of the message.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SystemStream (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.SystemStream
-
-
-
-
-
-
-
-Direct Known Subclasses:
-SystemStreamPartition
-public class SystemStream
-extends java.lang.Object
-Streams in Samza consist of both the stream name and the system to which the stream belongs.
- Systems are defined through the job config and have corresponding serdes, producers and
- consumers in order to deserialize, send to and retrieve from them. A stream name is dependent
- on its system, and may be the topic, queue name, file name, etc. as makes sense for a
- particular system.
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-protected java.lang.Stringstream
-
-protected java.lang.Stringsystem
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-SystemStream Constructs a Samza stream object from specified components.
-
-
-SystemStream SystemStream other)Constructs a Samza stream object based upon an existing Samza stream.
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals
-
-java.lang.StringgetStream
-
-java.lang.StringgetSystem
-
-inthashCode
-
-java.lang.StringtoString
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-SystemStream
-public SystemStream(java.lang.String system,
- java.lang.String stream)
-Constructs a Samza stream object from specified components.
-Parameters: system - The name of the system of which this stream is associated with.stream - The name of the stream as specified in the stream configuration file.
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-Enum Constants
-Enum Constant and Description
-
-
-NEWEST Signals the offset of the newest message in a SystemStreamPartition.
-
-
-OLDEST Signals the offset of the oldest message in a SystemStreamPartition.
-
-
-UPCOMING Signals the offset of the next message to be written into a
- SystemStreamPartition.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-UPCOMING
-public static final SystemStreamMetadata.OffsetType UPCOMING
-Signals the offset of the next message to be written into a
- SystemStreamPartition. If the offset of the most recent message written
- to a SystemStreamPartition is 7, then upcoming would signal offset 8
- (assuming the offsets were incremental).
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static SystemStreamMetadata.OffsetType valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata
-
-
-
-
-
-
-
-Enclosing class:
-SystemStreamMetadata
-public static class SystemStreamMetadata.SystemStreamPartitionMetadata
-extends java.lang.Object
-Provides offset information for a given SystemStreamPartition. This
- currently only includes offset information.
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
SystemStreamMetadata (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.SystemStreamMetadata
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
SystemStreamPartition (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-protected inthash
-
-protected Partition partition
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-hash
-protected final int hash
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-SystemStreamPartition
-public SystemStreamPartition(java.lang.String system,
- java.lang.String stream,
- Partition partition)
-Constructs a Samza stream partition object from specified components.
-Parameters: system - The name of the system of which this stream is associated with.stream - The name of the stream as specified in the stream configuration file.partition - The partition in the stream of which this object is associated with.
-
-
-
-
-
-
-
-
-
-
-SystemStreamPartition
-public SystemStreamPartition(SystemStream other,
- Partition partition)
-Constructs a Samza stream partition object based upon another Samza stream and a specified partition.
-Parameters: other - Reference to an already existing Samza stream.partition - Reference to an already existing Samza partition.
-
-
-
-
-
-
-
-
SystemStreamPartitionIterator (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.SystemStreamPartitionIterator
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-hasNext
-public boolean hasNext()
-
-Specified by: hasNext in interface java.util.Iterator<IncomingMessageEnvelope >
-
-
-
-
-
-
-
-
-
-
-
-remove
-public void remove()
-
-Specified by: remove in interface java.util.Iterator<IncomingMessageEnvelope >
-
-
-
-
-
-
-
BaseMessageChooser (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.system.chooser.BaseMessageChooser
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidregister SystemStreamPartition systemStreamPartition,
- java.lang.String offset)Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition.
-
-
-voidstart Called after all SystemStreamPartitions have been registered.
-
-
-voidstop Called when the chooser is about to be discarded.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-register
-public void register(SystemStreamPartition systemStreamPartition,
- java.lang.String offset)
-
-Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition. Register will only be
- called before start.
-
-Specified by: register MessageChooser Parameters: systemStreamPartition - A SystemStreamPartition that envelopes will be coming from.offset - The offset of the first message expected for the
- system/stream/partition that's being registered. If "7" were
- supplied as the offset, then the MessageChooser can expect the
- first message it is updated with for the system/stream/partition
- will have an offset of "7".
-
-
-
-
-
-
-
MessageChooser (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-IncomingMessageEnvelope choose The choose method is invoked when the SamzaContainer is ready to process a
- new message.
-
-
-voidregister SystemStreamPartition systemStreamPartition,
- java.lang.String offset)Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition.
-
-
-voidstart Called after all SystemStreamPartitions have been registered.
-
-
-voidstop Called when the chooser is about to be discarded.
-
-
-voidupdate IncomingMessageEnvelope envelope)Notify the chooser that a new envelope is available for a processing.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-register
-void register(SystemStreamPartition systemStreamPartition,
- java.lang.String offset)
-Called before start, to let the chooser know that it will be handling
- envelopes from the given SystemStreamPartition. Register will only be
- called before start.
-Parameters: systemStreamPartition - A SystemStreamPartition that envelopes will be coming from.offset - The offset of the first message expected for the
- system/stream/partition that's being registered. If "7" were
- supplied as the offset, then the MessageChooser can expect the
- first message it is updated with for the system/stream/partition
- will have an offset of "7".
-
-
-
-
-
-
-update
-void update(IncomingMessageEnvelope envelope)
-Notify the chooser that a new envelope is available for a processing. A
- MessageChooser will receive, at most, one outstanding envelope per
- system/stream/partition combination. For example, if update is called for
- partition 7 of kafka.mystream, then update will not be called with an
- envelope from partition 7 of kafka.mystream until the previous envelope has
- been returned via the choose method. Update will only be invoked after the
- chooser has been started.
-Parameters: envelope - An unprocessed envelope.
-
-
-
-
-
-
-choose
-IncomingMessageEnvelope choose()The choose method is invoked when the SamzaContainer is ready to process a
- new message. The chooser may elect to return any envelope that it's been
- given via the update method, which hasn't yet been returned. Choose will
- only be called after the chooser has been started.
-Returns: The next envelope to process, or null if the chooser has no
- messages or doesn't want to process any at the moment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MessageChooserFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.system.chooser (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
org.apache.samza.system.chooser (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-MessageChooser
-MessageChooser is an interface for programmatic fine-grain control over
- stream consumption.
-
-
-
-MessageChooserFactory
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-BaseMessageChooser
-An abstract MessageChooser that implements start/stop/register for choosers
- that don't use them.
-
-
-
-
-
-
-
org.apache.samza.system.chooser Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
org.apache.samza.system (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.apache.samza.system (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-SystemAdmin
-Helper interface attached to an underlying system to fetch
- information about streams, partitions, offsets, etc.
-
-
-
-SystemConsumer
-
- SystemConsumer is the interface that must be implemented by any system that
- wishes to integrate with Samza.
-
-
-
-SystemFactory
-
-
-
-
-SystemProducer
-SystemProducers are how Samza writes messages from
StreamTasks to outside systems,
- such as messaging systems like Kafka, or file systems.
-
-
-
-
-
-
-
-
-
-Enum Summary
-Enum
-Description
-
-
-
-SystemStreamMetadata.OffsetType
-OffsetType is an enum used to define which offset should be used when
- reading from a SystemStreamPartition for the first time.
-
-
-
-
-
-
-
org.apache.samza.system Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
ClosableTask (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidclose
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- InitableTask (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidinit Config config,
- TaskContext context)Called by TaskRunner each time an implementing task is created.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-init
-void init(Config config,
- TaskContext context)
- throws java.lang.Exception
-Called by TaskRunner each time an implementing task is created.
-Parameters: config - Allows accessing of fields in the configuration files that this StreamTask is specified in.context - Allows accessing of contextual data of this StreamTask.Throws: java.lang.Exception - Any exception types encountered during the execution of the processing task.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- MessageCollector (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidsend OutgoingMessageEnvelope envelope)Sends message envelope out onto specified stream.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- StreamTask (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-process
-void process(IncomingMessageEnvelope envelope,
- MessageCollector collector,
- TaskCoordinator coordinator)
- throws java.lang.Exception
-Called once for each message that this StreamTask receives.
-Parameters: envelope - Contains the received deserialized message and key, and also information regarding the stream and
- partition of which the message was received from.collector - Contains the means of sending message envelopes to the output stream. The collector must only
- be used during the current call to the process method; you should not reuse the collector between invocations
- of this method.coordinator - Manages execution of tasks.Throws: java.lang.Exception - Any exception types encountered during the execution of the processing task.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- TaskContext (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-Enum Constants
-Enum Constant and Description
-
-
-ALL_TASKS_IN_CONTAINER Indicates that a request applies to all tasks in the current container.
-
-
-CURRENT_TASK Indicates that a request applies only to the task making the call.
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-static TaskCoordinator.RequestScope valueOf Returns the enum constant of this type with the specified name.
-
-
-static TaskCoordinator.RequestScope []values Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static TaskCoordinator.RequestScope valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- TaskLifecycleListener (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-beforeInit
-void beforeInit(Config config,
- TaskContext context)
-Called before all tasks in TaskRunner are initialized.
-Parameters: config - Config for the Samza job.context - TaskContext for the StreamTask that's being initialized.
-
-
-
-
-
-
-afterInit
-void afterInit(Config config,
- TaskContext context)
-Called after all tasks in TaskRunner are initialized.
-Parameters: config - Config for the Samza job.context - TaskContext for the StreamTask that's being initialized.
-
-
-
-
-
-
-beforeProcess
-void beforeProcess(IncomingMessageEnvelope envelope,
- Config config,
- TaskContext context)
-Called before a message is processed by a task.
-Parameters: envelope - The envelope to be processed by the StreamTask.config - Config for the Samza job.context - TaskContext for the StreamTask that's about to process a message.
-
-
-
-
-
-
-afterProcess
-void afterProcess(IncomingMessageEnvelope envelope,
- Config config,
- TaskContext context)
-Called after a message is processed by a task.
-Parameters: envelope - The envelope that was processed by the StreamTask.config - Config for the Samza job.context - TaskContext for the StreamTask that just processed a message.
-
-
-
-
-
-
-beforeClose
-void beforeClose(Config config,
- TaskContext context)
-Called before all tasks in TaskRunner are closed.
-Parameters: config - Config for the Samza job.context - TaskContext for the StreamTask that's about to be shutdown.
-
-
-
-
-
-
-afterClose
-void afterClose(Config config,
- TaskContext context)
-Called after all tasks in TaskRunner are closed.
-Parameters: config - Config for the Samza job.context - TaskContext for the StreamTask that was just shutdown.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- TaskLifecycleListenerFactory (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- WindowableTask (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-voidwindow MessageCollector collector,
- TaskCoordinator coordinator)Called by TaskRunner for each implementing task at the end of every specified window.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-window
-void window(MessageCollector collector,
- TaskCoordinator coordinator)
- throws java.lang.Exception
-Called by TaskRunner for each implementing task at the end of every specified window.
-Parameters: collector - Contains the means of sending message envelopes to the output stream. The collector must only
- be used during the current call to the window method; you should not reuse the collector between invocations
- of this method.coordinator - Manages execution of tasks.Throws: java.lang.Exception - Any exception types encountered during the execution of the processing task.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)
-org.apache.samza.task (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-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,
- clean or close resources, etc.
-
-
-InitableTask
-Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks
- are instantiated by TaskRunner.
-
-
-
-MessageCollector
-Used as an interface for the means of sending message envelopes to an output stream.
-
-
-
-StreamTask
-A StreamTask is the basic class on which Samza jobs are implemented.
-
-
-
-TaskContext
-
-
-
-
-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
- to configured
CheckpointManagers or shutting down the task or all tasks within
- a container.
-
-
-TaskLifecycleListener
-Used to get before/after notifications before initializing/closing all tasks
- in a given container (JVM/process).
-
-
-
-TaskLifecycleListenerFactory
-
-
-
-
-WindowableTask
-Add-on interface to
StreamTask implementations to add code which will be run on
- a specified time interval (via configuration).
-
-
-
-
-
-
-
-
-
org.apache.samza.task Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-incPoll
-public void incPoll()
-
-
-
-
-
-
-
BlockingEnvelopeMap.BufferGauge (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.IntegergetValue
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.util.BlockingEnvelopeMap
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-register
-public void register(SystemStreamPartition systemStreamPartition,
- java.lang.String offset)
-
-Register a SystemStreamPartition to this SystemConsumer. The SystemConsumer
- should try and read messages from all SystemStreamPartitions that are
- registered to it. SystemStreamPartitions should only be registered before
- start is called.
-
-Specified by: register SystemConsumer Parameters: systemStreamPartition - The SystemStreamPartition object representing the Samza
- SystemStreamPartition to receive messages from.offset - String representing the offset of the point in the stream to start
- reading messages from. This is an inclusive parameter; if "7" were
- specified, the first message for the system/stream/partition to be
- consumed and returned would be a message whose offset is "7".
-
-
-
-
-
-
-
-
-
-
-
-poll
-public java.util.Map<SystemStreamPartition ,java.util.List<IncomingMessageEnvelope >> poll(java.util.Set<SystemStreamPartition > systemStreamPartitions,
- long timeout)
- throws java.lang.InterruptedException
-
-Poll the SystemConsumer to get any available messages from the underlying
- system.
-
-
- If the underlying implementation does not take care to adhere to the
- timeout parameter, the SamzaContainer's performance will suffer
- drastically. Specifically, if poll blocks when it's not supposed to, it
- will block the entire main thread in SamzaContainer, and no messages will
- be processed while blocking is occurring.
-
-Specified by: poll SystemConsumer Parameters: systemStreamPartitions - A set of SystemStreamPartition to poll for new messages. If
- SystemConsumer has messages available for other registered
- SystemStreamPartitions, but they are not in the
- systemStreamPartitions set in a given poll invocation, they can't
- be returned. It is illegal to pass in SystemStreamPartitions that
- have not been registered with the SystemConsumer first.timeout - If timeout < 0, poll will block unless all SystemStreamPartition
- are at "head" (the underlying system has been checked, and
- returned an empty set). If at head, an empty map is returned. If
- timeout >= 0, poll will return any messages that are currently
- available for any of the SystemStreamPartitions specified. If no
- new messages are available, it will wait up to timeout
- milliseconds for messages from any SystemStreamPartition to become
- available. It will return an empty map if the timeout is hit, and
- no new messages are available.Returns: A map from SystemStreamPartitions to any available
- IncomingMessageEnvelopes for the SystemStreamPartitions. If no
- messages are available for a SystemStreamPartition that was
- supplied in the polling set, the map will not contain a key for the
- SystemStreamPartition. Will return an empty map, not null, if no
- new messages are available for any SystemStreamPartitions in the
- input set.
-Throws: java.lang.InterruptedException - Thrown when a blocking poll has been interrupted by another
- thread.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Clock (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-longcurrentTimeMillis
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-currentTimeMillis
-long currentTimeMillis()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- NoOpMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.util.NoOpMetricsRegistry
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-Methods
-Modifier and Type
-Method and Description
-
-
-Counter newCounter Counter counter)Register existing
Counter with this registry
-
-Counter newCounter
-
-<T> Gauge <T>newGauge Gauge <T> gauge)Register an existing
Gauge
-
-<T> Gauge <T>newGauge Create and register a new
Gauge
-
-Timer newTimer Create and Register a new
Timer
-
-Timer newTimer Timer timer)Register existing
Timer with this registry
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
SinglePartitionWithoutOffsetsSystemAdmin (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.apache.samza.util.SinglePartitionWithoutOffsetsSystemAdmin
-
-
-
-
-
-
-
-All Implemented Interfaces:
-SystemAdmin
-public class SinglePartitionWithoutOffsetsSystemAdmin
-extends java.lang.Object
-implements SystemAdmin
-A simple helper admin class that defines a single partition (partition 0) for
- a given system. The metadata uses null for all offsets, which means that the
- stream doesn't support offsets, and will be treated as empty. This class
- should be used when a system has no concept of partitioning or offsets, since
- Samza needs at least one partition for an input stream, in order to read it.
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getSystemStreamMetadata
-public java.util.Map<java.lang.String,SystemStreamMetadata > getSystemStreamMetadata(java.util.Set<java.lang.String> streamNames)
-
-Fetch metadata from a system for a set of streams.
-
-Specified by: getSystemStreamMetadata SystemAdmin Parameters: streamNames - The streams to to fetch metadata for.Returns: A map from stream name to SystemStreamMetadata for each stream
- requested in the parameter set.
-
-
-
-
-
-
-
-getOffsetsAfter
-public java.util.Map<SystemStreamPartition ,java.lang.String> getOffsetsAfter(java.util.Map<SystemStreamPartition ,java.lang.String> offsets)
-
-Fetches the offsets for the messages immediately after the supplied offsets
- for a group of SystemStreamPartitions.
-
-Specified by: getOffsetsAfter SystemAdmin Parameters: offsets - Map from SystemStreamPartition to current offsets.Returns: Map from SystemStreamPartition to offsets immediately after the
- current offsets.
-
-
-
-
-
-
-
org.apache.samza.util (samza-api 0.8.0-SNAPSHOT API)
-
-
Interfaces
-
-
Classes
-
-
org.apache.samza.util (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-Clock
-Mockable interface for tracking time.
-
-
-
-
-
-
-
-
-
-
org.apache.samza.util Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-org.apache.samza.util.Clock
-
-
Overview List (samza-api 0.8.0-SNAPSHOT API)
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/overview-summary.html b/docs/learn/documentation/versioned/api/javadocs/overview-summary.html
deleted file mode 100644
index ffc8d6d715546317e4e2f36a65860c5d2f06b729..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/overview-summary.html
+++ /dev/null
@@ -1,175 +0,0 @@
-
-
-
-
-
-Overview (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/overview-tree.html b/docs/learn/documentation/versioned/api/javadocs/overview-tree.html
deleted file mode 100644
index 867af2821d9842d454645f65754da6853d0e08a6..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/overview-tree.html
+++ /dev/null
@@ -1,253 +0,0 @@
-
-
-
-
-
-Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
Serialized Form (samza-api 0.8.0-SNAPSHOT API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/learn/documentation/versioned/api/javadocs/stylesheet.css b/docs/learn/documentation/versioned/api/javadocs/stylesheet.css
deleted file mode 100644
index 0aeaa97fe05f89f7f1290a2d66d812f7f05bcf7e..0000000000000000000000000000000000000000
--- a/docs/learn/documentation/versioned/api/javadocs/stylesheet.css
+++ /dev/null
@@ -1,474 +0,0 @@
-/* Javadoc style sheet */
-/*
-Overall document style
-*/
-body {
- background-color:#ffffff;
- color:#353833;
- font-family:Arial, Helvetica, sans-serif;
- font-size:76%;
- margin:0;
-}
-a:link, a:visited {
- text-decoration:none;
- color:#4c6b87;
-}
-a:hover, a:focus {
- text-decoration:none;
- color:#bb7a2a;
-}
-a:active {
- text-decoration:none;
- color:#4c6b87;
-}
-a[name] {
- color:#353833;
-}
-a[name]:hover {
- text-decoration:none;
- color:#353833;
-}
-pre {
- font-size:1.3em;
-}
-h1 {
- font-size:1.8em;
-}
-h2 {
- font-size:1.5em;
-}
-h3 {
- font-size:1.4em;
-}
-h4 {
- font-size:1.3em;
-}
-h5 {
- font-size:1.2em;
-}
-h6 {
- font-size:1.1em;
-}
-ul {
- list-style-type:disc;
-}
-code, tt {
- font-size:1.2em;
-}
-dt code {
- font-size:1.2em;
-}
-table tr td dt code {
- font-size:1.2em;
- vertical-align:top;
-}
-sup {
- font-size:.6em;
-}
-/*
-Document title and Copyright styles
-*/
-.clear {
- clear:both;
- height:0px;
- overflow:hidden;
-}
-.aboutLanguage {
- float:right;
- padding:0px 21px;
- font-size:.8em;
- z-index:200;
- margin-top:-7px;
-}
-.legalCopy {
- margin-left:.5em;
-}
-.bar a, .bar a:link, .bar a:visited, .bar a:active {
- color:#FFFFFF;
- text-decoration:none;
-}
-.bar a:hover, .bar a:focus {
- color:#bb7a2a;
-}
-.tab {
- background-color:#0066FF;
- background-image:url(resources/titlebar.gif);
- background-position:left top;
- background-repeat:no-repeat;
- color:#ffffff;
- padding:8px;
- width:5em;
- font-weight:bold;
-}
-/*
-Navigation bar styles
-*/
-.bar {
- background-image:url(resources/background.gif);
- background-repeat:repeat-x;
- color:#FFFFFF;
- padding:.8em .5em .4em .8em;
- height:auto;/*height:1.8em;*/
- font-size:1em;
- margin:0;
-}
-.topNav {
- background-image:url(resources/background.gif);
- background-repeat:repeat-x;
- color:#FFFFFF;
- float:left;
- padding:0;
- width:100%;
- clear:right;
- height:2.8em;
- padding-top:10px;
- overflow:hidden;
-}
-.bottomNav {
- margin-top:10px;
- background-image:url(resources/background.gif);
- background-repeat:repeat-x;
- color:#FFFFFF;
- float:left;
- padding:0;
- width:100%;
- clear:right;
- height:2.8em;
- padding-top:10px;
- overflow:hidden;
-}
-.subNav {
- background-color:#dee3e9;
- border-bottom:1px solid #9eadc0;
- float:left;
- width:100%;
- overflow:hidden;
-}
-.subNav div {
- clear:left;
- float:left;
- padding:0 0 5px 6px;
-}
-ul.navList, ul.subNavList {
- float:left;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.navList li{
- list-style:none;
- float:left;
- padding:3px 6px;
-}
-ul.subNavList li{
- list-style:none;
- float:left;
- font-size:90%;
-}
-.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
- color:#FFFFFF;
- text-decoration:none;
-}
-.topNav a:hover, .bottomNav a:hover {
- text-decoration:none;
- color:#bb7a2a;
-}
-.navBarCell1Rev {
- background-image:url(resources/tab.gif);
- background-color:#a88834;
- color:#FFFFFF;
- margin: auto 5px;
- border:1px solid #c9aa44;
-}
-/*
-Page header and footer styles
-*/
-.header, .footer {
- clear:both;
- margin:0 20px;
- padding:5px 0 0 0;
-}
-.indexHeader {
- margin:10px;
- position:relative;
-}
-.indexHeader h1 {
- font-size:1.3em;
-}
-.title {
- color:#2c4557;
- margin:10px 0;
-}
-.subTitle {
- margin:5px 0 0 0;
-}
-.header ul {
- margin:0 0 25px 0;
- padding:0;
-}
-.footer ul {
- margin:20px 0 5px 0;
-}
-.header ul li, .footer ul li {
- list-style:none;
- font-size:1.2em;
-}
-/*
-Heading styles
-*/
-div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
- background-color:#dee3e9;
- border-top:1px solid #9eadc0;
- border-bottom:1px solid #9eadc0;
- margin:0 0 6px -8px;
- padding:2px 5px;
-}
-ul.blockList ul.blockList ul.blockList li.blockList h3 {
- background-color:#dee3e9;
- border-top:1px solid #9eadc0;
- border-bottom:1px solid #9eadc0;
- margin:0 0 6px -8px;
- padding:2px 5px;
-}
-ul.blockList ul.blockList li.blockList h3 {
- padding:0;
- margin:15px 0;
-}
-ul.blockList li.blockList h2 {
- padding:0px 0 20px 0;
-}
-/*
-Page layout container styles
-*/
-.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
- clear:both;
- padding:10px 20px;
- position:relative;
-}
-.indexContainer {
- margin:10px;
- position:relative;
- font-size:1.0em;
-}
-.indexContainer h2 {
- font-size:1.1em;
- padding:0 0 3px 0;
-}
-.indexContainer ul {
- margin:0;
- padding:0;
-}
-.indexContainer ul li {
- list-style:none;
-}
-.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
- font-size:1.1em;
- font-weight:bold;
- margin:10px 0 0 0;
- color:#4E4E4E;
-}
-.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
- margin:10px 0 10px 20px;
-}
-.serializedFormContainer dl.nameValue dt {
- margin-left:1px;
- font-size:1.1em;
- display:inline;
- font-weight:bold;
-}
-.serializedFormContainer dl.nameValue dd {
- margin:0 0 0 1px;
- font-size:1.1em;
- display:inline;
-}
-/*
-List styles
-*/
-ul.horizontal li {
- display:inline;
- font-size:0.9em;
-}
-ul.inheritance {
- margin:0;
- padding:0;
-}
-ul.inheritance li {
- display:inline;
- list-style:none;
-}
-ul.inheritance li ul.inheritance {
- margin-left:15px;
- padding-left:15px;
- padding-top:1px;
-}
-ul.blockList, ul.blockListLast {
- margin:10px 0 10px 0;
- padding:0;
-}
-ul.blockList li.blockList, ul.blockListLast li.blockList {
- list-style:none;
- margin-bottom:25px;
-}
-ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
- padding:0px 20px 5px 10px;
- border:1px solid #9eadc0;
- background-color:#f9f9f9;
-}
-ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
- padding:0 0 5px 8px;
- background-color:#ffffff;
- border:1px solid #9eadc0;
- border-top:none;
-}
-ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
- margin-left:0;
- padding-left:0;
- padding-bottom:15px;
- border:none;
- border-bottom:1px solid #9eadc0;
-}
-ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
- list-style:none;
- border-bottom:none;
- padding-bottom:0;
-}
-table tr td dl, table tr td dl dt, table tr td dl dd {
- margin-top:0;
- margin-bottom:1px;
-}
-/*
-Table styles
-*/
-.contentContainer table, .classUseContainer table, .constantValuesContainer table {
- border-bottom:1px solid #9eadc0;
- width:100%;
-}
-.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table {
- width:100%;
-}
-.contentContainer .description table, .contentContainer .details table {
- border-bottom:none;
-}
-.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{
- vertical-align:top;
- padding-right:20px;
-}
-.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast,
-.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast,
-.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne,
-.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne {
- padding-right:3px;
-}
-.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption {
- position:relative;
- text-align:left;
- background-repeat:no-repeat;
- color:#FFFFFF;
- font-weight:bold;
- clear:none;
- overflow:hidden;
- padding:0px;
- margin:0px;
-}
-caption a:link, caption a:hover, caption a:active, caption a:visited {
- color:#FFFFFF;
-}
-.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span {
- white-space:nowrap;
- padding-top:8px;
- padding-left:8px;
- display:block;
- float:left;
- background-image:url(resources/titlebar.gif);
- height:18px;
-}
-.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd {
- width:10px;
- background-image:url(resources/titlebar_end.gif);
- background-repeat:no-repeat;
- background-position:top right;
- position:relative;
- float:left;
-}
-ul.blockList ul.blockList li.blockList table {
- margin:0 0 12px 0px;
- width:100%;
-}
-.tableSubHeadingColor {
- background-color: #EEEEFF;
-}
-.altColor {
- background-color:#eeeeef;
-}
-.rowColor {
- background-color:#ffffff;
-}
-.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td {
- text-align:left;
- padding:3px 3px 3px 7px;
-}
-th.colFirst, th.colLast, th.colOne, .constantValuesContainer th {
- background:#dee3e9;
- border-top:1px solid #9eadc0;
- border-bottom:1px solid #9eadc0;
- text-align:left;
- padding:3px 3px 3px 7px;
-}
-td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
- font-weight:bold;
-}
-td.colFirst, th.colFirst {
- border-left:1px solid #9eadc0;
- white-space:nowrap;
-}
-td.colLast, th.colLast {
- border-right:1px solid #9eadc0;
-}
-td.colOne, th.colOne {
- border-right:1px solid #9eadc0;
- border-left:1px solid #9eadc0;
-}
-table.overviewSummary {
- padding:0px;
- margin-left:0px;
-}
-table.overviewSummary td.colFirst, table.overviewSummary th.colFirst,
-table.overviewSummary td.colOne, table.overviewSummary th.colOne {
- width:25%;
- vertical-align:middle;
-}
-table.packageSummary td.colFirst, table.overviewSummary th.colFirst {
- width:25%;
- vertical-align:middle;
-}
-/*
-Content styles
-*/
-.description pre {
- margin-top:0;
-}
-.deprecatedContent {
- margin:0;
- padding:10px 0;
-}
-.docSummary {
- padding:0;
-}
-/*
-Formatting effect styles
-*/
-.sourceLineNo {
- color:green;
- padding:0 30px 0 0;
-}
-h1.hidden {
- visibility:hidden;
- overflow:hidden;
- font-size:.9em;
-}
-.block {
- display:block;
- margin:3px 0 0 0;
-}
-.strong {
- font-weight:bold;
-}