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

A

activate() - Method in interface org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionState

Activates this execution state within the ExecutionStateSampler.ExecutionStateTracker.

addBundleProgressReporter(BundleProgressReporter) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register a callback whenever progress is being requested.

addFinishBundleFunction(ThrowingRunnable) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register any DoFn.FinishBundle methods.

addIncomingDataEndpoint(Endpoints.ApiServiceDescriptor, Coder<T>, FnDataReceiver<T>) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

addIncomingTimerEndpoint(String, Coder<Timer<T>>, FnDataReceiver<Timer<T>>) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

addOutgoingDataEndpoint(Endpoints.ApiServiceDescriptor, Coder<T>) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Registers the outbound data endpoint with given Endpoints.ApiServiceDescriptor and Coder, returns the FnDataReceiver responsible for sending the outbound data.

addOutgoingTimersEndpoint(String, Coder<Timer<T>>) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Registers the outbound timers endpoint with given timer family id and Coder, returns the FnDataReceiver responsible for sending the outbound timers.

addPCollectionConsumer(String, FnDataReceiver<WindowedValue<T>>) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register as a consumer for a given PCollection id.

addResetFunction(ThrowingRunnable) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register any reset methods.

addStartBundleFunction(ThrowingRunnable) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register any DoFn.StartBundle methods.

addTearDownFunction(ThrowingRunnable) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register a tear down handler.

append(T) - Method in class org.apache.beam.fn.harness.state.BagUserState

asyncClose() - Method in class org.apache.beam.fn.harness.state.BagUserState

asyncClose() - Method in class org.apache.beam.fn.harness.state.MultimapUserState

B

BagUserState<T> - Class in org.apache.beam.fn.harness.state

An implementation of a bag user state that utilizes the Beam Fn State API to fetch, clear and persist values.

BagUserState(Cache<?, ?>, BeamFnStateClient, String, BeamFnApi.StateKey, Coder<T>) - Constructor for class org.apache.beam.fn.harness.state.BagUserState

The cache must be namespaced for this state object accordingly.

BeamFnControlClient - Class in org.apache.beam.fn.harness.control

A client for the Beam Fn Control API.

BeamFnControlClient(Endpoints.ApiServiceDescriptor, ManagedChannelFactory, OutboundObserverFactory, Executor, EnumMap<BeamFnApi.InstructionRequest.RequestCase, ThrowingFunction<BeamFnApi.InstructionRequest, BeamFnApi.InstructionResponse.Builder>>) - Constructor for class org.apache.beam.fn.harness.control.BeamFnControlClient

BeamFnControlClient(BeamFnControlGrpc.BeamFnControlStub, OutboundObserverFactory, Executor, EnumMap<BeamFnApi.InstructionRequest.RequestCase, ThrowingFunction<BeamFnApi.InstructionRequest, BeamFnApi.InstructionResponse.Builder>>) - Constructor for class org.apache.beam.fn.harness.control.BeamFnControlClient

BeamFnDataClient - Interface in org.apache.beam.fn.harness.data

The BeamFnDataClient is able to forward inbound elements to a FnDataReceiver and provide a receiver of outbound elements.

BeamFnDataGrpcClient - Class in org.apache.beam.fn.harness.data

A BeamFnDataClient that uses gRPC for sending and receiving data.

BeamFnDataGrpcClient(PipelineOptions, Function<Endpoints.ApiServiceDescriptor, ManagedChannel>, OutboundObserverFactory) - Constructor for class org.apache.beam.fn.harness.data.BeamFnDataGrpcClient

BeamFnDataReadRunner<OutputT> - Class in org.apache.beam.fn.harness

Registers as a consumer for data over the Beam Fn API.

BeamFnDataReadRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle reading from the Fn Api Data Plane.

BeamFnDataWriteRunner<InputT> - Class in org.apache.beam.fn.harness

Registers as a consumer with the Beam Fn Data Api.

BeamFnDataWriteRunner() - Constructor for class org.apache.beam.fn.harness.BeamFnDataWriteRunner

BeamFnDataWriteRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle writing to the Fn Api Data Plane.

BeamFnLoggingClient - Class in org.apache.beam.fn.harness.logging

Configures java.util.logging to send all LogRecords via the Beam Fn Logging API.

BeamFnLoggingMDC - Class in org.apache.beam.fn.harness.logging

Mapped diagnostic context to be consumed and set on LogEntry protos in BeamFnLoggingClient.

BeamFnLoggingMDC() - Constructor for class org.apache.beam.fn.harness.logging.BeamFnLoggingMDC

BeamFnStateClient - Interface in org.apache.beam.fn.harness.state

The BeamFnStateClient is able to forward state requests to a handler which returns a corresponding response or error if completed unsuccessfully.

BeamFnStateGrpcClientCache - Class in org.apache.beam.fn.harness.state

A cache of BeamFnStateClients which handle Beam Fn State requests using gRPC.

BeamFnStateGrpcClientCache(IdGenerator, ManagedChannelFactory, OutboundObserverFactory) - Constructor for class org.apache.beam.fn.harness.state.BeamFnStateGrpcClientCache

BeamFnStatusClient - Class in org.apache.beam.fn.harness.status

BeamFnStatusClient(Endpoints.ApiServiceDescriptor, Function<Endpoints.ApiServiceDescriptor, ManagedChannel>, ProcessBundleHandler.BundleProcessorCache, PipelineOptions, Cache<?, ?>) - Constructor for class org.apache.beam.fn.harness.status.BeamFnStatusClient

bindBag(String, StateSpec<BagState<T>>, Coder<T>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindCombining(String, StateSpec<CombiningState<ElementT, AccumT, ResultT>>, Coder<AccumT>, Combine.CombineFn<ElementT, AccumT, ResultT>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindCombiningWithContext(String, StateSpec<CombiningState<ElementT, AccumT, ResultT>>, Coder<AccumT>, CombineWithContext.CombineFnWithContext<ElementT, AccumT, ResultT>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindMap(String, StateSpec<MapState<KeyT, ValueT>>, Coder<KeyT>, Coder<ValueT>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindMultimap(String, StateSpec<MultimapState<KeyT, ValueT>>, Coder<KeyT>, Coder<ValueT>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindOrderedList(String, StateSpec<OrderedListState<T>>, Coder<T>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindSet(String, StateSpec<SetState<T>>, Coder<T>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindValue(String, StateSpec<ValueState<T>>, Coder<T>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

bindWatermark(String, StateSpec<WatermarkHoldState>, TimestampCombiner) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

Deprecated.

The Fn API has no plans to implement WatermarkHoldState as of this writing and is waiting on resolution of BEAM-2535.

blockTillReadFinishes() - Method in class org.apache.beam.fn.harness.BeamFnDataReadRunner

Builder() - Constructor for class org.apache.beam.fn.harness.logging.QuotaEvent.Builder

bundleProcessingThreadCounter(String, MetricName) - Static method in class org.apache.beam.fn.harness.control.Metrics

Returns a counter that will report an accurate final value.

bundleProcessingThreadDistribution(String, MetricName) - Static method in class org.apache.beam.fn.harness.control.Metrics

Returns a Distribution that will report an accurate final value.

BundleProcessor() - Constructor for class org.apache.beam.fn.harness.control.ProcessBundleHandler.BundleProcessor

BundleProgressReporter - Interface in org.apache.beam.fn.harness.control

Reports metrics related to bundle processing.

BundleProgressReporter.InMemory - Class in org.apache.beam.fn.harness.control

An in-memory bundle progress reporter and registrar.

BundleProgressReporter.Registrar - Interface in org.apache.beam.fn.harness.control

Maintains a set of BundleProgressReporters.

BundleSplitListener - Interface in org.apache.beam.fn.harness.control

Listens to splits happening to a single bundle application.

BundleSplitListener.InMemory - Class in org.apache.beam.fn.harness.control

A BundleSplitListener which gathers all splits produced and stores them in memory.

C

Cache<K,V> - Interface in org.apache.beam.fn.harness

A cache allows for the storage and retrieval of values which are associated with keys.

Cache.Shrinkable<V> - Interface in org.apache.beam.fn.harness

An interface that marks an object that can be reduced in size instead of being evicted completely.

Caches - Class in org.apache.beam.fn.harness

Utility methods used to instantiate and operate over cache instances.

Caches() - Constructor for class org.apache.beam.fn.harness.Caches

Caches.ClearableCache<K,V> - Class in org.apache.beam.fn.harness

A cache that tracks keys that have been inserted into the cache and supports clearing them.

clear() - Method in class org.apache.beam.fn.harness.Caches.ClearableCache

Removes all tracked keys from the cache.

clear() - Method in class org.apache.beam.fn.harness.control.BundleSplitListener.InMemory

clear() - Method in class org.apache.beam.fn.harness.state.BagUserState

clear() - Method in class org.apache.beam.fn.harness.state.MultimapUserState

ClearableCache(Cache<K, V>) - Constructor for class org.apache.beam.fn.harness.Caches.ClearableCache

close() - Method in class org.apache.beam.fn.harness.ExternalWorkerService

close() - Method in class org.apache.beam.fn.harness.logging.BeamFnLoggingClient

close() - Method in class org.apache.beam.fn.harness.logging.QuotaEvent.QuotaEventCloseable

close() - Method in class org.apache.beam.fn.harness.status.BeamFnStatusClient

Coder(Supplier<Cache<?, ?>>, BeamFnStateClient, Supplier<String>, Coder<T>) - Constructor for class org.apache.beam.fn.harness.state.StateBackedIterable.Coder

CombineRunners - Class in org.apache.beam.fn.harness

Executes different components of Combine PTransforms.

CombineRunners() - Constructor for class org.apache.beam.fn.harness.CombineRunners

CombineRunners.PrecombineFactory<KeyT,InputT,AccumT> - Class in org.apache.beam.fn.harness

A factory for PrecombineRunners.

CombineRunners.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle combine component PTransforms.

combining(PipelineOptions, Cache<Object, Object>, Combine.CombineFn<InputT, AccumT, ?>, Coder<K>, boolean) - Static method in class org.apache.beam.fn.harness.PrecombineGroupingTable

Returns a grouping table that combines inputs into an accumulator.

combiningAndSampling(PipelineOptions, Cache<Object, Object>, Combine.CombineFn<InputT, AccumT, ?>, Coder<K>, double, boolean) - Static method in class org.apache.beam.fn.harness.PrecombineGroupingTable

Returns a grouping table that combines inputs into an accumulator with sampling SizeEstimators.

computeIfAbsent(K, Function<K, V>) - Method in interface org.apache.beam.fn.harness.Cache

Looks up the specified key and returns the associated value.

computeIfAbsent(K, Function<K, V>) - Method in class org.apache.beam.fn.harness.Caches.ClearableCache

contains(PCollectionView<T>) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

create() - Static method in class org.apache.beam.fn.harness.control.BundleSplitListener.InMemory

create() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler

Returns a new ExecutionStateSampler.ExecutionStateTracker associated with this state sampler.

create(String, String, String, String) - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Returns an ExecutionStateSampler.ExecutionState bound to this tracker for the specified transform and processing state.

create(String, String, Thread, long, String) - Static method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

create(Cache<Object, Object>, BundleProgressReporter.InMemory, BeamFnApi.ProcessBundleDescriptor, PTransformFunctionRegistry, PTransformFunctionRegistry, List<ThrowingRunnable>, List<ThrowingRunnable>, BundleSplitListener.InMemory, PCollectionConsumerRegistry, ProcessBundleHandler.MetricsEnvironmentStateForBundle, ExecutionStateSampler.ExecutionStateTracker, ProcessBundleHandler.HandleStateCallsForBundle, Collection<FinalizeBundleHandler.CallbackRegistration>, Set<String>) - Static method in class org.apache.beam.fn.harness.control.ProcessBundleHandler.BundleProcessor

create(PipelineOptions) - Static method in class org.apache.beam.fn.harness.debug.DataSampler

Optionally returns a DataSampler if the experiment "enable_data_sampling" is present or "enable_always_on_exception_sampling" is present.

create() - Method in class org.apache.beam.fn.harness.logging.QuotaEvent.Builder

Puts the given values in the MDC as a quota event.

create(String, Coder<?>, Coder<W>, ViewFn<?, ?>, WindowMappingFn<W>) - Static method in class org.apache.beam.fn.harness.state.SideInputSpec

createAndStart(PipelineOptions, Endpoints.ApiServiceDescriptor, Function<Endpoints.ApiServiceDescriptor, ManagedChannel>) - Static method in class org.apache.beam.fn.harness.logging.BeamFnLoggingClient

createIterator() - Method in class org.apache.beam.fn.harness.state.StateBackedIterable

createOutboundAggregator(Endpoints.ApiServiceDescriptor, Supplier<String>, boolean) - Method in interface org.apache.beam.fn.harness.data.BeamFnDataClient

Creates a BeamFnDataOutboundAggregator for buffering and sending outbound data and timers over the data plane.

createOutboundAggregator(Endpoints.ApiServiceDescriptor, Supplier<String>, boolean) - Method in class org.apache.beam.fn.harness.data.BeamFnDataGrpcClient

createRunnerForPTransform(PTransformRunnerFactory.Context) - Method in class org.apache.beam.fn.harness.CombineRunners.PrecombineFactory

createRunnerForPTransform(PTransformRunnerFactory.Context) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory

Creates and returns a handler for a given PTransform.

D

DataSampler - Class in org.apache.beam.fn.harness.debug

The DataSampler is a global (per SDK Harness) object that facilitates taking and returning samples to the Runner Harness.

DataSampler() - Constructor for class org.apache.beam.fn.harness.debug.DataSampler

Creates a DataSampler to sample every 1000 elements while keeping a maximum of 10 in memory.

DataSampler(Boolean) - Constructor for class org.apache.beam.fn.harness.debug.DataSampler

Creates a DataSampler to sample every 1000 elements while keeping a maximum of 10 in memory.

DataSampler(int, int, Boolean) - Constructor for class org.apache.beam.fn.harness.debug.DataSampler

deactivate() - Method in interface org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionState

Restores the previously active execution state within the ExecutionStateSampler.ExecutionStateTracker.

decodeToIterable(List<T>) - Method in class org.apache.beam.fn.harness.state.StateBackedIterable.Coder

decodeToIterable(List<T>, long, InputStream) - Method in class org.apache.beam.fn.harness.state.StateBackedIterable.Coder

DEFAULT_SLEEP_TIME_MILLIS - Static variable in class org.apache.beam.fn.harness.status.MemoryMonitor

Amount of time (in ms) this thread must sleep between two consecutive iterations.

delegateOnInstructionRequestType(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.control.BeamFnControlClient

describeMemory() - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

Return a string describing the current memory state of the server.

describeStats() - Method in interface org.apache.beam.fn.harness.Cache

Returns a string containing caching statistics.

dumpHeap() - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

Dump the current heap profile to a file in the given directory and return its name.

E

ElementSample<T> - Class in org.apache.beam.fn.harness.debug

A record class that wraps an element sample with additional metadata.

ElementSample.ExceptionMetadata - Class in org.apache.beam.fn.harness.debug

encode(Iterable<T>, OutputStream) - Method in class org.apache.beam.fn.harness.state.StateBackedIterable.Coder

error() - Method in interface org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionState

Sets the error state to the currently executing state.

estimateSize(Object) - Method in interface org.apache.beam.fn.harness.PrecombineGroupingTable.SizeEstimator

eternal() - Static method in class org.apache.beam.fn.harness.Caches

A cache that never evicts any values.

exception - Variable in class org.apache.beam.fn.harness.debug.ElementSample

exception(ElementSample<T>, Exception, String, String) - Method in class org.apache.beam.fn.harness.debug.OutputSampler

Samples an exceptional element to be later queried.

ExecutionStateSampler - Class in org.apache.beam.fn.harness.control

Monitors the execution of one or more execution threads.

ExecutionStateSampler(PipelineOptions, DateTimeUtils.MillisProvider) - Constructor for class org.apache.beam.fn.harness.control.ExecutionStateSampler

ExecutionStateSampler.ExecutionState - Interface in org.apache.beam.fn.harness.control

An ExecutionStateSampler.ExecutionState represents the current state of an execution thread.

ExecutionStateSampler.ExecutionStateTracker - Class in org.apache.beam.fn.harness.control

Tracks the current state of a single execution thread.

ExecutionStateSampler.ExecutionStateTrackerStatus - Class in org.apache.beam.fn.harness.control

ExecutionStateTrackerStatus() - Constructor for class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

ExternalWorkerService - Class in org.apache.beam.fn.harness

Implements the BeamFnExternalWorkerPool service by starting a fresh SDK harness for each request.

ExternalWorkerService(PipelineOptions) - Constructor for class org.apache.beam.fn.harness.ExternalWorkerService

F

finalizeBundle(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.control.FinalizeBundleHandler

FinalizeBundleHandler - Class in org.apache.beam.fn.harness.control

A bundle finalization handler that expires entries after a specified amount of time.

FinalizeBundleHandler(ExecutorService) - Constructor for class org.apache.beam.fn.harness.control.FinalizeBundleHandler

finalizeState() - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

find(String) - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler.BundleProcessorCache

Finds an active bundle processor for the specified instructionId or null if one could not be found.

FlattenRunner<InputT> - Class in org.apache.beam.fn.harness

Executes flatten PTransforms.

FlattenRunner() - Constructor for class org.apache.beam.fn.harness.FlattenRunner

FlattenRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle flatten PTransforms.

flush(FnDataReceiver<WindowedValue<KV<K, AccumT>>>) - Method in class org.apache.beam.fn.harness.PrecombineGroupingTable

Flushes all entries in this table to output.

FnApiDoFnRunner<InputT,RestrictionT,PositionT,WatermarkEstimatorStateT,OutputT> - Class in org.apache.beam.fn.harness

A DoFnRunner specific to integrating with the Fn Api.

FnApiDoFnRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle Java DoFns.

FnApiStateAccessor<K> - Class in org.apache.beam.fn.harness.state

Provides access to side inputs and state via a BeamFnStateClient.

FnApiStateAccessor(PipelineOptions, Set<String>, String, Supplier<String>, Supplier<List<BeamFnApi.ProcessBundleRequest.CacheToken>>, Supplier<Cache<?, ?>>, Cache<?, ?>, Map<TupleTag<?>, SideInputSpec>, BeamFnStateClient, Coder<K>, Coder<BoundedWindow>, Supplier<K>, Supplier<BoundedWindow>) - Constructor for class org.apache.beam.fn.harness.state.FnApiStateAccessor

FnApiTimerBundleTracker<K> - Class in org.apache.beam.fn.harness.state

FnApiTimerBundleTracker(Coder<K>, Coder<BoundedWindow>, Supplier<K>, Supplier<BoundedWindow>) - Constructor for class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker

FnApiTimerBundleTracker.Modifications<K> - Class in org.apache.beam.fn.harness.state

FnApiTimerBundleTracker.TimerInfo<K> - Class in org.apache.beam.fn.harness.state

FnHarness - Class in org.apache.beam.fn.harness

Main entry point into the Beam SDK Fn Harness for Java.

FnHarness() - Constructor for class org.apache.beam.fn.harness.FnHarness

forApiServiceDescriptor(Endpoints.ApiServiceDescriptor) - Method in class org.apache.beam.fn.harness.state.BeamFnStateGrpcClientCache

Creates or returns an existing BeamFnStateClient depending on whether the passed in Endpoints.ApiServiceDescriptor currently has a BeamFnStateClient bound to the same channel.

forPTransform(String, RunnerApi.PTransform) - Method in interface org.apache.beam.fn.harness.MapFnRunners.ValueMapFnFactory

forPTransform(String, RunnerApi.PTransform) - Method in interface org.apache.beam.fn.harness.MapFnRunners.WindowedValueMapFnFactory

forValueMapFnFactory(MapFnRunners.ValueMapFnFactory<InputT, OutputT>) - Static method in class org.apache.beam.fn.harness.MapFnRunners

Create a MapFnRunners where the map function consumes elements directly.

forwardElementToConsumer(WindowedValue<OutputT>) - Method in class org.apache.beam.fn.harness.BeamFnDataReadRunner

forWindowedValueMapFnFactory(MapFnRunners.WindowedValueMapFnFactory<InputT, OutputT>) - Static method in class org.apache.beam.fn.harness.MapFnRunners

Create a MapFnRunners where the map function consumes Windowed Values and produced Windowed Values.

fromOptions(PipelineOptions) - Static method in class org.apache.beam.fn.harness.Caches

Uses the specified PipelineOptions to configure and return a cache instance based upon parameters within SdkHarnessOptions.

fromOptions(PipelineOptions) - Static method in class org.apache.beam.fn.harness.status.MemoryMonitor

fromOptions(PipelineOptions) - Static method in class org.apache.beam.fn.harness.stream.HarnessStreamObserverFactories

Creates an OutboundObserverFactory for client-side RPCs.

G

get() - Method in class org.apache.beam.fn.harness.state.BagUserState

get(PCollectionView<T>, BoundedWindow) - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

get() - Method in class org.apache.beam.fn.harness.state.IterableSideInput

get() - Method in class org.apache.beam.fn.harness.state.MultimapSideInput

get(K) - Method in class org.apache.beam.fn.harness.state.MultimapSideInput

get(K) - Method in class org.apache.beam.fn.harness.state.MultimapUserState

getActiveBundleProcessors() - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler.BundleProcessorCache

getBeamFnDataClient() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A client for handling inbound and outbound data streams.

getBeamFnStateClient() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A client for handling state requests.

getBundleCacheSupplier() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A cache that is used for each bundle and cleared when the bundle completes.

getBundleFinalizer() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Register callbacks that will be invoked when the runner completes the bundle.

getBundleModifications() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker

getBundleProcessorCache() - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler

getCache() - Method in interface org.apache.beam.fn.harness.state.StateBackedIterable.StateBackedIterableTranslationContext

getCacheTokensSupplier() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A supplier containing the active cache tokens for this bundle.

getCoders() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

An immutable mapping from coder id to coder definition.

getCoderTranslators() - Method in class org.apache.beam.fn.harness.state.StateBackedIterable.Registrar

getCoderURNs() - Method in class org.apache.beam.fn.harness.state.StateBackedIterable.Registrar

getCurrentInstructionId() - Method in interface org.apache.beam.fn.harness.state.StateBackedIterable.StateBackedIterableTranslationContext

getCurrentThreadsPTransformId() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Returns the ptransform id of the currently executing thread.

getFunctions() - Method in class org.apache.beam.fn.harness.data.PTransformFunctionRegistry

getInstructionId() - Static method in class org.apache.beam.fn.harness.logging.BeamFnLoggingMDC

Gets the Instruction ID of the current thread.

getLastTransitionTimeMillis() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

getMetricsContainer() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Returns a MetricsContainer that delegates based upon the current execution state to the appropriate metrics container that is bound to the current ExecutionStateSampler.ExecutionState or to the unbound MetricsContainer if no execution state is currently running.

getMetricsContainerRegistry() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Returns the MetricsContainerStepMap that is managed by this ExecutionStateSampler.ExecutionStateTracker.

getModifiedEventTimersOrdered() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.Modifications

getModifiedProcessingTimersOrdered() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.Modifications

getModifiedSynchronizedProcessingTimersOrdered() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.Modifications

getModifiedTimerIds() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.Modifications

getModifiedTimersOrdered(TimeDomain) - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.Modifications

getMultiplexingConsumer(String) - Method in class org.apache.beam.fn.harness.data.PCollectionConsumerRegistry

New consumers should not be register()-ed after calling this method.

getPCollectionConsumer(String) - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Returns a FnDataReceiver to send output to for the specified PCollection id.

getPCollections() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

An immutable mapping from PCollection id to PCollection definition.

getPipelineOptions() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

Pipeline options.

getPrimaryRoots() - Method in class org.apache.beam.fn.harness.control.BundleSplitListener.InMemory

getPrimaryRoots() - Method in class org.apache.beam.fn.harness.HandlesSplits.SplitResult

getProcessBundleId() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

getProcessBundleInstructionIdSupplier() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A supplier containing the active process bundle instruction id.

getProcessWideCache() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A cache that is process wide and persists across bundle boundaries.

getProgress() - Method in interface org.apache.beam.fn.harness.HandlesSplits

Returns the current progress of the active element as a fraction between 0.0 and 1.0.

getPTransform() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

The PTransform definition.

getPTransformId() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

getPTransformId() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

The id of the PTransform.

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.BeamFnDataReadRunner.Registrar

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.BeamFnDataWriteRunner.Registrar

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.CombineRunners.Registrar

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.FlattenRunner.Registrar

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.FnApiDoFnRunner.Registrar

getPTransformRunnerFactories() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Registrar

Returns a mapping from RunnerApi.FunctionSpec#getUrn() to a factory capable of instantiating an appropriate handler.

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.ToStringFnRunner.Registrar

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.WindowMappingFnRunner.Registrar

getPTransformRunnerFactories() - Method in class org.apache.beam.fn.harness.WindowMergingFnRunner.Registrar

getPTransformUniqueName() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

getResidualRoots() - Method in class org.apache.beam.fn.harness.control.BundleSplitListener.InMemory

getResidualRoots() - Method in class org.apache.beam.fn.harness.HandlesSplits.SplitResult

getRunnerCapabilities() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

An immutable set of runner capability urns.

getShortIdMap() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A way to get or create monitoring short ids.

getSplitListener() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

A listener to be invoked when the PTransform splits itself.

getStateClient() - Method in interface org.apache.beam.fn.harness.state.StateBackedIterable.StateBackedIterableTranslationContext

getStateTracker() - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler.BundleProcessor

getStateTracker() - Static method in class org.apache.beam.fn.harness.logging.BeamFnLoggingMDC

Gets the State Tracker of the current thread.

getStatus() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Returns status information related to this tracker or null if not tracking a bundle.

getTimeDomain() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.TimerInfo

getTimer() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.TimerInfo

getTimerFamilyOrId() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.TimerInfo

getTrackedThread() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTrackerStatus

getWeight() - Method in class org.apache.beam.fn.harness.PrecombineGroupingTable

getWindowingStrategies() - Method in interface org.apache.beam.fn.harness.PTransformRunnerFactory.Context

An immutable mapping from windowing strategy id to windowing strategy definition.

H

handle(BeamFnApi.StateRequest.Builder) - Method in interface org.apache.beam.fn.harness.state.BeamFnStateClient

Consumes a state request populating a unique id returning a future to the response.

handleDataSampleRequest(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.debug.DataSampler

Returns all collected samples.

HandlesSplits - Interface in org.apache.beam.fn.harness

An interface that may be used to extend a FnDataReceiver signalling that the downstream runner is capable of performing splitting and providing progress reporting.

HandlesSplits.SplitResult - Class in org.apache.beam.fn.harness

harnessMonitoringInfos(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.control.HarnessMonitoringInfosInstructionHandler

HarnessMonitoringInfosInstructionHandler - Class in org.apache.beam.fn.harness.control

Processes BeamFnApi.InstructionRequest's BeamFnApi.HarnessMonitoringInfosResponse

HarnessMonitoringInfosInstructionHandler(ShortIdMap) - Constructor for class org.apache.beam.fn.harness.control.HarnessMonitoringInfosInstructionHandler

HarnessStreamObserverFactories - Class in org.apache.beam.fn.harness.stream

Uses PipelineOptions to configure which underlying StreamObserver implementation to use in the java SDK harness.

HarnessStreamObserverFactories() - Constructor for class org.apache.beam.fn.harness.stream.HarnessStreamObserverFactories

hashCode() - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler.BundleProcessorCache

I

id - Variable in class org.apache.beam.fn.harness.debug.ElementSample

InMemory() - Constructor for class org.apache.beam.fn.harness.control.BundleProgressReporter.InMemory

InMemory() - Constructor for class org.apache.beam.fn.harness.control.BundleSplitListener.InMemory

isEmpty() - Method in class org.apache.beam.fn.harness.state.FnApiStateAccessor

isThrashing() - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

IterableSideInput<T> - Class in org.apache.beam.fn.harness.state

An implementation of a iterable side input that utilizes the Beam Fn State API to fetch values.

IterableSideInput(Cache<?, ?>, BeamFnStateClient, String, BeamFnApi.StateKey, Coder<T>) - Constructor for class org.apache.beam.fn.harness.state.IterableSideInput

J

JAVA_SOURCE_URN - Static variable in class org.apache.beam.fn.harness.control.ProcessBundleHandler

K

keys() - Method in class org.apache.beam.fn.harness.state.MultimapUserState

M

main(String[]) - Static method in class org.apache.beam.fn.harness.ExternalWorkerService

Worker pool entry point.

main(String[]) - Static method in class org.apache.beam.fn.harness.FnHarness

main(Function<String, String>) - Static method in class org.apache.beam.fn.harness.FnHarness

main(String, PipelineOptions, Set<String>, Endpoints.ApiServiceDescriptor, Endpoints.ApiServiceDescriptor, Endpoints.ApiServiceDescriptor) - Static method in class org.apache.beam.fn.harness.FnHarness

Run a FnHarness with the given id and options that attaches to the specified logging and control API service descriptors.

main(String, PipelineOptions, Set<String>, Endpoints.ApiServiceDescriptor, Endpoints.ApiServiceDescriptor, Endpoints.ApiServiceDescriptor, ManagedChannelFactory, OutboundObserverFactory, Cache<Object, Object>) - Static method in class org.apache.beam.fn.harness.FnHarness

Run a FnHarness with the given id and options that attaches to the specified logging and control API service descriptors using the given channel factory and outbound observer factory.

MapFnRunners - Class in org.apache.beam.fn.harness

Utilities to create PTransformRunners which execute simple map functions.

MapFnRunners() - Constructor for class org.apache.beam.fn.harness.MapFnRunners

MapFnRunners.ValueMapFnFactory<InputT,OutputT> - Interface in org.apache.beam.fn.harness

A function factory which given a PTransform returns a map function.

MapFnRunners.WindowedValueMapFnFactory<InputT,OutputT> - Interface in org.apache.beam.fn.harness

A function factory which given a PTransform returns a map function over the entire WindowedValue of input and output elements.

MemoryMonitor - Class in org.apache.beam.fn.harness.status

A runnable which monitors a server for GC thrashing.

MemoryMonitor.GCStatsProvider - Interface in org.apache.beam.fn.harness.status

Abstract interface for providing GC stats (for testing).

message - Variable in class org.apache.beam.fn.harness.debug.ElementSample.ExceptionMetadata

Metrics - Class in org.apache.beam.fn.harness.control

Metrics() - Constructor for class org.apache.beam.fn.harness.control.Metrics

Metrics.BundleCounter - Interface in org.apache.beam.fn.harness.control

A Counter that is designed to report intermediate and final results and can be re-used after being reset.

Metrics.BundleDistribution - Interface in org.apache.beam.fn.harness.control

A Distribution that is designed to report intermediate and final results and can be re-used after being reset.

Modifications() - Constructor for class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.Modifications

MultimapSideInput<K,V> - Class in org.apache.beam.fn.harness.state

An implementation of a multimap side input that utilizes the Beam Fn State API to fetch values.

MultimapSideInput(Cache<?, ?>, BeamFnStateClient, String, BeamFnApi.StateKey, Coder<K>, Coder<V>, boolean) - Constructor for class org.apache.beam.fn.harness.state.MultimapSideInput

MultimapUserState<K,V> - Class in org.apache.beam.fn.harness.state

An implementation of a multimap user state that utilizes the Beam Fn State API to fetch, clear and persist values.

MultimapUserState(Cache<?, ?>, BeamFnStateClient, String, BeamFnApi.StateKey, Coder<K>, Coder<V>) - Constructor for class org.apache.beam.fn.harness.state.MultimapUserState

N

noop() - Static method in class org.apache.beam.fn.harness.Caches

A cache that never stores any values.

O

of(List<BeamFnApi.BundleApplication>, List<BeamFnApi.DelayedBundleApplication>) - Static method in class org.apache.beam.fn.harness.HandlesSplits.SplitResult

of(Timer<K>, String, TimeDomain) - Static method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.TimerInfo

org.apache.beam.fn.harness - package org.apache.beam.fn.harness

Top level package for Beam Java Fn Harness.

org.apache.beam.fn.harness.control - package org.apache.beam.fn.harness.control

Control service client and individual request handlers.

org.apache.beam.fn.harness.data - package org.apache.beam.fn.harness.data

Data service client and logical stream multiplexing.

org.apache.beam.fn.harness.debug - package org.apache.beam.fn.harness.debug

Classes and utilities related to debugging features.

org.apache.beam.fn.harness.logging - package org.apache.beam.fn.harness.logging

Logging service client and JUL logging handler adapter.

org.apache.beam.fn.harness.state - package org.apache.beam.fn.harness.state

State client and state caching.

org.apache.beam.fn.harness.status - package org.apache.beam.fn.harness.status

Worker status client.

org.apache.beam.fn.harness.stream - package org.apache.beam.fn.harness.stream

gRPC stream management.

OutputSampler<T> - Class in org.apache.beam.fn.harness.debug

This class holds samples for a single PCollection until queried by the parent DataSampler.

OutputSampler(Coder<?>, int, int, boolean) - Constructor for class org.apache.beam.fn.harness.debug.OutputSampler

outputTimers(Function<String, FnDataReceiver<Timer<?>>>) - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker

P

PCollectionConsumerRegistry - Class in org.apache.beam.fn.harness.data

The PCollectionConsumerRegistry is used to maintain a collection of consuming FnDataReceiver for each pCollectionId.

PCollectionConsumerRegistry(ExecutionStateSampler.ExecutionStateTracker, ShortIdMap, BundleProgressReporter.Registrar, BeamFnApi.ProcessBundleDescriptor) - Constructor for class org.apache.beam.fn.harness.data.PCollectionConsumerRegistry

PCollectionConsumerRegistry(ExecutionStateSampler.ExecutionStateTracker, ShortIdMap, BundleProgressReporter.Registrar, BeamFnApi.ProcessBundleDescriptor, DataSampler) - Constructor for class org.apache.beam.fn.harness.data.PCollectionConsumerRegistry

peek(K) - Method in interface org.apache.beam.fn.harness.Cache

Looks up the specified key returning null if the value is not within the cache.

PrecombineFactory() - Constructor for class org.apache.beam.fn.harness.CombineRunners.PrecombineFactory

PrecombineGroupingTable<K,InputT,AccumT> - Class in org.apache.beam.fn.harness

Static utility methods that provide a grouping table implementation.

PrecombineGroupingTable.SizeEstimator - Interface in org.apache.beam.fn.harness

Provides client-specific operations for size estimates.

processBundle(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler

Processes a bundle, running the start(), process(), and finish() functions.

ProcessBundleHandler - Class in org.apache.beam.fn.harness.control

Processes BeamFnApi.ProcessBundleRequests and BeamFnApi.ProcessBundleSplitRequests.

ProcessBundleHandler(PipelineOptions, Set<String>, Function<String, BeamFnApi.ProcessBundleDescriptor>, BeamFnDataClient, BeamFnStateGrpcClientCache, FinalizeBundleHandler, ShortIdMap, ExecutionStateSampler, Cache<Object, Object>, DataSampler) - Constructor for class org.apache.beam.fn.harness.control.ProcessBundleHandler

ProcessBundleHandler.BundleProcessor - Class in org.apache.beam.fn.harness.control

A container for the reusable information used to process a bundle.

ProcessBundleHandler.BundleProcessorCache - Class in org.apache.beam.fn.harness.control

A cache for ProcessBundleHandler.BundleProcessors.

progress(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler

PTransformFunctionRegistry - Class in org.apache.beam.fn.harness.data

A class to register and retrieve functions for bundle processing (i.e.

PTransformFunctionRegistry(ShortIdMap, ExecutionStateSampler.ExecutionStateTracker, String) - Constructor for class org.apache.beam.fn.harness.data.PTransformFunctionRegistry

Construct the registry to run for either start or finish bundle functions.

ptransformId - Variable in class org.apache.beam.fn.harness.debug.ElementSample.ExceptionMetadata

PTransformRunnerFactory<T> - Interface in org.apache.beam.fn.harness

A factory able to instantiate an appropriate handler for a given PTransform.

PTransformRunnerFactory.Context - Interface in org.apache.beam.fn.harness

A context used to instantiate and support the handler necessary to execute the PTransform.

PTransformRunnerFactory.Registrar - Interface in org.apache.beam.fn.harness

A registrar which can return a mapping from RunnerApi.FunctionSpec#getUrn() to a factory capable of instantiating an appropriate handler.

put(K, V) - Method in interface org.apache.beam.fn.harness.Cache

Inserts a new value associated with the given key or updates an existing association of the same key with the new value.

put(K, V) - Method in class org.apache.beam.fn.harness.Caches.ClearableCache

put(WindowedValue<KV<K, InputT>>, FnDataReceiver<WindowedValue<KV<K, AccumT>>>) - Method in class org.apache.beam.fn.harness.PrecombineGroupingTable

Adds the key and value to this table, possibly flushing some entries to output if the table is full.

put(K, V) - Method in class org.apache.beam.fn.harness.state.MultimapUserState

Q

QuotaEvent - Class in org.apache.beam.fn.harness.logging

Adds MDC key:value pairs for a quota event.

QuotaEvent() - Constructor for class org.apache.beam.fn.harness.logging.QuotaEvent

QuotaEvent.Builder - Class in org.apache.beam.fn.harness.logging

QuotaEvent.QuotaEventCloseable - Class in org.apache.beam.fn.harness.logging

QuotaEventCloseable(Map<String, String>) - Constructor for class org.apache.beam.fn.harness.logging.QuotaEvent.QuotaEventCloseable

R

readAllAndDecodeStartingFrom(Cache<?, ?>, BeamFnStateClient, BeamFnApi.StateRequest, Coder<T>) - Static method in class org.apache.beam.fn.harness.state.StateFetchingIterators

This adapter handles using the continuation token to provide iteration over all the elements returned by the Beam Fn State API using the supplied state client, state request for the first chunk of the state stream, and a value decoder.

REFERENCE_SIZE - Static variable in class org.apache.beam.fn.harness.Caches

The size of a reference.

register(BundleProgressReporter) - Method in class org.apache.beam.fn.harness.control.BundleProgressReporter.InMemory

register(BundleProgressReporter) - Method in interface org.apache.beam.fn.harness.control.BundleProgressReporter.Registrar

Adds the reporter to be reported on.

register(String, String, String, FnDataReceiver<WindowedValue<T>>) - Method in class org.apache.beam.fn.harness.data.PCollectionConsumerRegistry

Register the specified consumer to handle the elements in the pCollection associated with pCollectionId.

register(String, String, ThrowingRunnable) - Method in class org.apache.beam.fn.harness.data.PTransformFunctionRegistry

Register the runnable to process the specific pTransformId and track its execution time.

registerCallbacks(String, Collection<FinalizeBundleHandler.CallbackRegistration>) - Method in class org.apache.beam.fn.harness.control.FinalizeBundleHandler

registerReceiver(String, List<Endpoints.ApiServiceDescriptor>, CloseableFnDataReceiver<BeamFnApi.Elements>) - Method in interface org.apache.beam.fn.harness.data.BeamFnDataClient

Registers a receiver for the provided instruction id.

registerReceiver(String, List<Endpoints.ApiServiceDescriptor>, CloseableFnDataReceiver<BeamFnApi.Elements>) - Method in class org.apache.beam.fn.harness.data.BeamFnDataGrpcClient

Registrar() - Constructor for class org.apache.beam.fn.harness.BeamFnDataReadRunner.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.BeamFnDataWriteRunner.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.CombineRunners.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.FlattenRunner.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.FnApiDoFnRunner.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.state.StateBackedIterable.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.ToStringFnRunner.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.WindowMappingFnRunner.Registrar

Registrar() - Constructor for class org.apache.beam.fn.harness.WindowMergingFnRunner.Registrar

remove(K) - Method in interface org.apache.beam.fn.harness.Cache

Removes the mapping for a key from the cache if it is present.

remove(K) - Method in class org.apache.beam.fn.harness.Caches.ClearableCache

remove(K) - Method in class org.apache.beam.fn.harness.state.MultimapUserState

removeNestedKey(String, String) - Static method in class org.apache.beam.fn.harness.FnHarness

reset() - Method in class org.apache.beam.fn.harness.BeamFnDataReadRunner

reset() - Method in class org.apache.beam.fn.harness.control.BundleProgressReporter.InMemory

reset() - Method in interface org.apache.beam.fn.harness.control.BundleProgressReporter

Reset the monitoring data after a bundle has finished processing to be re-used for a future bundle.

reset() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Stops tracking execution states allowing for the ExecutionStateSampler.ExecutionStateTracker to be re-used for another bundle.

reset() - Static method in class org.apache.beam.fn.harness.logging.BeamFnLoggingMDC

Resets to a default state.

reset() - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker

run() - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

Runs this thread.

S

sample - Variable in class org.apache.beam.fn.harness.debug.ElementSample

sample(WindowedValue<T>) - Method in class org.apache.beam.fn.harness.debug.OutputSampler

Samples every sampleEveryNth element or if it is part of the first 10 in the (local) PCollection.

sampleOutput(String, Coder<T>) - Method in class org.apache.beam.fn.harness.debug.DataSampler

Creates and returns a class to sample the given PCollection in the given ProcessBundleDescriptor.

samples() - Method in class org.apache.beam.fn.harness.debug.OutputSampler

Clears samples at end of call.

sendInstructionResponse(BeamFnApi.InstructionResponse) - Method in class org.apache.beam.fn.harness.control.BeamFnControlClient

setEnabled(boolean) - Static method in class org.apache.beam.fn.harness.logging.QuotaEvent

Set whether this feature is enabled.

setInstructionId(String) - Static method in class org.apache.beam.fn.harness.logging.BeamFnLoggingMDC

Sets the Instruction ID of the current thread, which will be inherited by child threads.

setStateTracker(ExecutionStateSampler.ExecutionStateTracker) - Static method in class org.apache.beam.fn.harness.logging.BeamFnLoggingMDC

Sets the State Tracker of the current thread, which will be inherited by child threads.

shouldUpdateOnSizeChange(long, long) - Static method in class org.apache.beam.fn.harness.Caches

Returns whether the cache should be updated in the case where the objects size has changed.

shrink() - Method in interface org.apache.beam.fn.harness.Cache.Shrinkable

Returns a new object that is smaller than the object being evicted.

shrink() - Method in class org.apache.beam.fn.harness.PrecombineGroupingTable

shutdown() - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler

Shutdown the bundles, running the tearDown() functions.

SideInputSpec<W extends org.apache.beam.sdk.transforms.windowing.BoundedWindow> - Class in org.apache.beam.fn.harness.state

A specification for side inputs containing the access pattern, a value Coder, the window Coder, the ViewFn, and the WindowMappingFn.

SideInputSpec() - Constructor for class org.apache.beam.fn.harness.state.SideInputSpec

split(List<BeamFnApi.BundleApplication>, List<BeamFnApi.DelayedBundleApplication>) - Method in class org.apache.beam.fn.harness.control.BundleSplitListener.InMemory

split(List<BeamFnApi.BundleApplication>, List<BeamFnApi.DelayedBundleApplication>) - Method in interface org.apache.beam.fn.harness.control.BundleSplitListener

Signals that the current application should be split into the given primary and residual roots.

SplitResult() - Constructor for class org.apache.beam.fn.harness.HandlesSplits.SplitResult

start(String) - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

Starts tracking execution states for specified processBundleId.

start() - Method in class org.apache.beam.fn.harness.ExternalWorkerService

startWorker(BeamFnApi.StartWorkerRequest, StreamObserver<BeamFnApi.StartWorkerResponse>) - Method in class org.apache.beam.fn.harness.ExternalWorkerService

StateBackedIterable<T> - Class in org.apache.beam.fn.harness.state

A state backed iterable which allows for fetching elements over the portability state API.

StateBackedIterable(Cache<?, ?>, BeamFnStateClient, String, BeamFnApi.StateKey, Coder<T>, List<T>) - Constructor for class org.apache.beam.fn.harness.state.StateBackedIterable

StateBackedIterable.Coder<T> - Class in org.apache.beam.fn.harness.state

Decodes an Iterable that might be backed by state.

StateBackedIterable.Registrar - Class in org.apache.beam.fn.harness.state

A CoderTranslatorRegistrar for beam:coder:state_backed_iterable:v1.

StateBackedIterable.StateBackedIterableTranslationContext - Interface in org.apache.beam.fn.harness.state

Additional parameters required by the StateBackedIterable.Coder.

StateFetchingIterators - Class in org.apache.beam.fn.harness.state

Adapters which convert a logical series of chunks using continuation tokens over the Beam Fn State API into an Iterator of ByteStrings.

stop() - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler

Stops the execution of the state sampler.

stop() - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

Request the memory monitor stops.

stopWorker(BeamFnApi.StopWorkerRequest, StreamObserver<BeamFnApi.StopWorkerResponse>) - Method in class org.apache.beam.fn.harness.ExternalWorkerService

subCache(Cache<?, ?>, Object, Object...) - Static method in class org.apache.beam.fn.harness.Caches

Returns a view of a cache that operates on keys with a specified key prefix.

T

terminationFuture() - Method in class org.apache.beam.fn.harness.control.BeamFnControlClient

This method blocks until the control stream has completed.

terminationFuture() - Method in class org.apache.beam.fn.harness.logging.BeamFnLoggingClient

TimerInfo() - Constructor for class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker.TimerInfo

timerModified(String, TimeDomain, Timer<K>) - Method in class org.apache.beam.fn.harness.state.FnApiTimerBundleTracker

toString() - Method in class org.apache.beam.fn.harness.logging.BeamFnLoggingClient

ToStringFnRunner - Class in org.apache.beam.fn.harness

Translates from elements to human-readable string.

ToStringFnRunner() - Constructor for class org.apache.beam.fn.harness.ToStringFnRunner

ToStringFnRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle translating elements to a human readable string.

totalGCTimeMilliseconds() - Method in interface org.apache.beam.fn.harness.status.MemoryMonitor.GCStatsProvider

Return the total milliseconds spent in GC since JVM was started.

trySplit(BeamFnApi.ProcessBundleSplitRequest, BeamFnApi.ProcessBundleSplitResponse.Builder) - Method in class org.apache.beam.fn.harness.BeamFnDataReadRunner

trySplit(BeamFnApi.InstructionRequest) - Method in class org.apache.beam.fn.harness.control.ProcessBundleHandler

Splits an active bundle.

trySplit(double) - Method in interface org.apache.beam.fn.harness.HandlesSplits

Returns null if the split was unsuccessful.

tryToDumpHeap() - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

Dumps the heap to a file and return the name of the file, or null if the heap should not or could not be dumped.

U

unregisterReceiver(String, List<Endpoints.ApiServiceDescriptor>) - Method in interface org.apache.beam.fn.harness.data.BeamFnDataClient

Receivers are only expected to be unregistered when bundle processing has completed successfully.

unregisterReceiver(String, List<Endpoints.ApiServiceDescriptor>) - Method in class org.apache.beam.fn.harness.data.BeamFnDataGrpcClient

updateFinalMonitoringData(Map<String, ByteString>) - Method in class org.apache.beam.fn.harness.control.BundleProgressReporter.InMemory

updateFinalMonitoringData(Map<String, ByteString>) - Method in interface org.apache.beam.fn.harness.control.BundleProgressReporter

Update the monitoring data for a bundle that has finished processing.

updateFinalMonitoringData(Map<String, ByteString>) - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

updateIntermediateMonitoringData(Map<String, ByteString>) - Method in class org.apache.beam.fn.harness.control.BundleProgressReporter.InMemory

updateIntermediateMonitoringData(Map<String, ByteString>) - Method in interface org.apache.beam.fn.harness.control.BundleProgressReporter

Update the monitoring data for a bundle that is currently being processed.

updateIntermediateMonitoringData(Map<String, ByteString>) - Method in class org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

W

waitForResources(String) - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

Return only when the server is not in the GC thrashing state.

waitForThrashingState(boolean) - Method in class org.apache.beam.fn.harness.status.MemoryMonitor

For testing only: Wait for thrashing status to be updated to given value.

weigh(Object) - Static method in class org.apache.beam.fn.harness.Caches

Returns the amount of memory in bytes the provided object consumes.

WindowMappingFnRunner - Class in org.apache.beam.fn.harness

Represents mapping of main input window onto side input window.

WindowMappingFnRunner() - Constructor for class org.apache.beam.fn.harness.WindowMappingFnRunner

WindowMappingFnRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle mapping main input windows onto side input windows.

WindowMergingFnRunner<T,W extends org.apache.beam.sdk.transforms.windowing.BoundedWindow> - Class in org.apache.beam.fn.harness

Merges windows using a WindowFn.

WindowMergingFnRunner() - Constructor for class org.apache.beam.fn.harness.WindowMergingFnRunner

WindowMergingFnRunner.Registrar - Class in org.apache.beam.fn.harness

A registrar which provides a factory to handle merging windows based upon the WindowFn.

withFullResourceName(String) - Method in class org.apache.beam.fn.harness.logging.QuotaEvent.Builder

withMessageText(String) - Method in class org.apache.beam.fn.harness.logging.QuotaEvent.Builder

withOperation(String) - Method in class org.apache.beam.fn.harness.logging.QuotaEvent.Builder

withQuotaName(String) - Method in class org.apache.beam.fn.harness.logging.QuotaEvent.Builder

writeReplace() - Method in class org.apache.beam.fn.harness.state.StateBackedIterable

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