@Internal

Package org.apache.beam.sdk.util

For internal use only; no backwards compatibility guarantees.

Defines utilities that can be used by Beam runners.

Interface Summary

Interface	Description
BackOff	Back-off policy when retrying an operation.
HistogramData.BucketType
MutationDetector	An object for detecting illegal mutations.
NameUtils.NameOverride	Classes may implement this interface to change how names are generated for their instances.
ShardedFile	Bare-bones class for using sharded files.
Sleeper	Sleeper interface to use for requesting the current thread to sleep as specified in Thread.sleep(long).
ThrowingRunnable	Like Runnable but allowed to throw any exception.
ThrowingSupplier<T>	Like Supplier but allowed to throw any exception.
Weighted	Interface representing an object that has a weight, in unspecified units.
WindowedValue.SingleWindowedValue	A WindowedValue which holds exactly single window per value.

Class Summary

Class	Description
ApiSurface	Represents the API surface of a package prefix.
AppliedCombineFn<K,InputT,AccumT,OutputT>	A CombineFnBase.GlobalCombineFn with a fixed accumulator coder.
BackOffUtils	Utilities for BackOff.
BitSetCoder	Deprecated. use BitSetCoder instead
BucketingFunction	Keep track of the minimum/maximum/sum of a set of timestamped long values.
BufferedElementCountingOutputStream	Provides an efficient encoding for Iterables containing small values by buffering up to bufferSize bytes of data before prefixing the count.
ByteStringOutputStream	An OutputStream that produces ByteStrings.
CoderUtils	Utilities for working with Coders.
CombineContextFactory	Factory that produces Combine.Context based on different inputs.
CombineFnUtil	Static utility methods that create combine function instances.
DoFnInfo<InputT,OutputT>	Wrapper class holding the necessary information to serialize a DoFn.
DoFnWithExecutionInformation	The data that the Java SDK harness needs to execute a DoFn.
EmptyOnDeserializationThreadLocal<T>	A Serializable ThreadLocal which discards any "stored" objects.
ExplicitShardedFile	A sharded file where the file names are simply provided.
ExposedByteArrayInputStream	ByteArrayInputStream that allows accessing the entire internal buffer without copying.
ExposedByteArrayOutputStream	ByteArrayOutputStream special cased to treat writes of a single byte-array specially.
FilePatternMatchingShardedFile	A sharded file which matches a given file pattern.
FluentBackoff	A fluent builder for BackOff objects that allows customization of the retry algorithm.
HistogramData	A histogram that supports estimated percentile with linear interpolation.
HistogramData.LinearBuckets
IdentityWindowFn<T>	A WindowFn that leaves all associations between elements and windows unchanged.
InstanceBuilder<T>	Utility for creating objects dynamically.
LzoCompression
MimeTypes	Constants representing various mime types.
MoreFutures	Utilities to do future programming with Java 8.
MoreFutures.ExceptionOrResult<T>	An object that represents either a result or an exceptional termination.
MovingFunction	Keep track of the moving minimum/maximum/sum of sampled long values.
MutationDetectors	Static methods for creating and working with MutationDetector.
NameUtils	Helpers for extracting the name of objects and classes.
NoopLock	A lock which can always be acquired.
NumberedShardedFile	Utility methods for working with sharded files.
Preconditions	Beam-specific variants of Preconditions that throws more appropriate exception classes while being static analysis friendly.
PythonCallableSource	A wrapper object storing a Python function definition that can be evaluated to Python callables in Python SDK.
ReleaseInfo	Properties pertaining to this release of Apache Beam.
RowJson	Jackson serializer and deserializer for Rows.
RowJson.RowJsonDeserializer	Jackson deserializer for parsing JSON into Rows.
RowJson.RowJsonSerializer	Jackson serializer for converting Rows to JSON.
RowJsonUtils	Utilities for working with RowJson.RowJsonSerializer and RowJson.RowJsonDeserializer.
SerializableThrowable	A wrapper around Throwable that preserves the stack trace on serialization, unlike regular Throwable.
SerializableUtils	Utilities for working with Serializables.
ShardedKey<K>	A sharded key consisting of a user key and an opaque shard id represented by bytes.
ShardedKey.Coder<K>
ShardingWritableByteChannel	Implements a WritableByteChannel that may contain multiple output shards.
StreamUtils	Utility functions for stream operations.
StringUtils	Utilities for working with JSON and other human-readable string formats.
UnboundedScheduledExecutorService	An unbounded ScheduledExecutorService based upon the ScheduledThreadPoolExecutor API contract.
UnownedInputStream	A OutputStream wrapper which protects against the user attempting to modify the underlying stream by closing it or using mark.
UnownedOutputStream	A OutputStream wrapper which protects against the user attempting to modify the underlying stream by closing it.
VarInt	Variable-length encoding for integers.
WeightedValue<T>	A T with an accompanying weight.
WindowedValue<T>	An immutable triple of value, timestamp, and windows.
WindowedValue.FullWindowedValueCoder<T>	Coder for WindowedValue.
WindowedValue.ParamWindowedValueCoder<T>	A parameterized coder for WindowedValue.
WindowedValue.ValueOnlyWindowedValueCoder<T>	Deprecated. Use ParamWindowedValueCoder instead, it is a general purpose implementation of the same concept but makes timestamp, windows and pane info configurable.
WindowedValue.WindowedValueCoder<T>	Abstract class for WindowedValue coder.
WindowTracing	Logging for window operations.
ZipFiles	Functions for zipping a directory (including a subdirectory) into a ZIP-file or unzipping it again.

Enum Summary

Enum	Description
MoreFutures.ExceptionOrResult.IsException	Describes whether the result was an exception.
RowJson.RowJsonDeserializer.NullBehavior	An enumeration type for specifying how RowJson.RowJsonDeserializer should expect null values to be represented.

Exception Summary

Exception	Description
IllegalMutationException	Thrown when a value appears to have been mutated, but that mutation is forbidden.
RowJson.UnsupportedRowJsonException	Gets thrown when Row parsing or serialization fails for any reason.
UserCodeException	An exception that was thrown in user-code.

Annotation Types Summary

Annotation Type	Description
SystemDoFnInternal	Annotation to mark DoFns as an internal component of the Beam SDK.