org.apache.beam.sdk.common.runner.v1

Class RunnerApi

java.lang.Object

org.apache.beam.sdk.common.runner.v1.RunnerApi

public final class RunnerApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.AccumulationMode Whether or not subsequent outputs of aggregations should be entire replacement values or just the aggregation of inputs received since the prior output.
static interface	RunnerApi.AccumulationModeOrBuilder
static class	RunnerApi.BagStateSpec Protobuf type org.apache.beam.runner_api.v1.BagStateSpec
static interface	RunnerApi.BagStateSpecOrBuilder
static class	RunnerApi.ClosingBehavior Controls whether or not an aggregating transform should output data when a window expires.
static interface	RunnerApi.ClosingBehaviorOrBuilder
static class	RunnerApi.Coder A coder, the binary format for serialization and deserialization of data in a pipeline.
static interface	RunnerApi.CoderOrBuilder
static class	RunnerApi.CombinePayload The payload for the special-but-not-primitive Combine transform.
static interface	RunnerApi.CombinePayloadOrBuilder
static class	RunnerApi.CombiningStateSpec Protobuf type org.apache.beam.runner_api.v1.CombiningStateSpec
static interface	RunnerApi.CombiningStateSpecOrBuilder
static class	RunnerApi.Components A set of mappings from id to message.
static interface	RunnerApi.ComponentsOrBuilder
static class	RunnerApi.DisplayData TODO: transfer javadoc here
static interface	RunnerApi.DisplayDataOrBuilder
static class	RunnerApi.Environment An environment for executing UDFs.
static interface	RunnerApi.EnvironmentOrBuilder
static class	RunnerApi.FunctionSpec A URN along with a parameter object whose schema is determined by the URN.
static interface	RunnerApi.FunctionSpecOrBuilder
static class	RunnerApi.IsBounded Protobuf type org.apache.beam.runner_api.v1.IsBounded
static interface	RunnerApi.IsBoundedOrBuilder
static class	RunnerApi.MapStateSpec Protobuf type org.apache.beam.runner_api.v1.MapStateSpec
static interface	RunnerApi.MapStateSpecOrBuilder
static class	RunnerApi.MergeStatus Whether or not a PCollection's WindowFn is non-merging, merging, or merging-but-already-merged, in which case a subsequent GroupByKey is almost always going to do something the user does not want
static interface	RunnerApi.MergeStatusOrBuilder
static class	RunnerApi.MessageWithComponents A disjoint union of all the things that may contain references that require Components to resolve.
static interface	RunnerApi.MessageWithComponentsOrBuilder
static class	RunnerApi.OnTimeBehavior Controls whether or not an aggregating transform should output data when an on-time pane is empty.
static interface	RunnerApi.OnTimeBehaviorOrBuilder
static class	RunnerApi.OutputTime When a number of windowed, timestamped inputs are aggregated, the timestamp for the resulting output.
static interface	RunnerApi.OutputTimeOrBuilder
static class	RunnerApi.Parameter Parameters that a UDF might require.
static interface	RunnerApi.ParameterOrBuilder
static class	RunnerApi.ParDoPayload The payload for the primitive ParDo transform.
static interface	RunnerApi.ParDoPayloadOrBuilder
static class	RunnerApi.PCollection A PCollection!
static interface	RunnerApi.PCollectionOrBuilder
static class	RunnerApi.Pipeline A Pipeline is a hierarchical graph of PTransforms, linked by PCollections.
static interface	RunnerApi.PipelineOrBuilder
static class	RunnerApi.PTransform An applied PTransform! This does not contain the graph data, but only the fields specific to a graph node that is a Runner API transform between PCollections.
static interface	RunnerApi.PTransformOrBuilder
static class	RunnerApi.ReadPayload The payload for the primitive Read transform.
static interface	RunnerApi.ReadPayloadOrBuilder
static class	RunnerApi.SdkFunctionSpec A specification of a user defined function.
static interface	RunnerApi.SdkFunctionSpecOrBuilder
static class	RunnerApi.SetStateSpec Protobuf type org.apache.beam.runner_api.v1.SetStateSpec
static interface	RunnerApi.SetStateSpecOrBuilder
static class	RunnerApi.SideInput A specification for how to "side input" a PCollection.
static interface	RunnerApi.SideInputOrBuilder
static class	RunnerApi.StateSpec Protobuf type org.apache.beam.runner_api.v1.StateSpec
static interface	RunnerApi.StateSpecOrBuilder
static class	RunnerApi.TestStreamPayload The payload for the test-only primitive TestStream
static interface	RunnerApi.TestStreamPayloadOrBuilder
static class	RunnerApi.TimeDomain The different time domains in the Beam model.
static interface	RunnerApi.TimeDomainOrBuilder
static class	RunnerApi.TimerSpec Protobuf type org.apache.beam.runner_api.v1.TimerSpec
static interface	RunnerApi.TimerSpecOrBuilder
static class	RunnerApi.TimestampTransform A specification for a transformation on a timestamp.
static interface	RunnerApi.TimestampTransformOrBuilder
static class	RunnerApi.Trigger A small DSL for expressing when to emit new aggregations from a GroupByKey or CombinePerKey A trigger is described in terms of when it is _ready_ to permit output.
static interface	RunnerApi.TriggerOrBuilder
static class	RunnerApi.ValueStateSpec Protobuf type org.apache.beam.runner_api.v1.ValueStateSpec
static interface	RunnerApi.ValueStateSpecOrBuilder
static class	RunnerApi.WindowingStrategy A windowing strategy describes the window function, triggering, allowed lateness, and accumulation mode for a PCollection.
static interface	RunnerApi.WindowingStrategyOrBuilder
static class	RunnerApi.WindowIntoPayload The payload for the WindowInto transform.
static interface	RunnerApi.WindowIntoPayloadOrBuilder
static class	RunnerApi.WriteFilesPayload The payload for the special-but-not-primitive WriteFiles transform.
static interface	RunnerApi.WriteFilesPayloadOrBuilder

Method Summary

Modifier and Type	Method and Description
static com.google.protobuf.Descriptors.FileDescriptor	getDescriptor()
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)

getDescriptor

public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()