Package org.apache.beam.sdk.transforms
Annotation Type DoFn.GetInitialRestriction
-
@Documented @Retention(RUNTIME) @Target(METHOD) public static @interface DoFn.GetInitialRestriction
Annotation for the method that maps an element to an initial restriction for a splittableDoFn
.Signature:
RestrictionT getInitialRestriction(<arguments>);
This method must satisfy the following constraints:
- The return type
RestrictionT
defines the restriction type used within this splittable DoFn. All other methods that use a@Restriction
parameter must use the same type that is used here. It is suggested to use as narrow of a return type definition as possible (for example prefer to use a square type over a shape type as a square is a type of a shape). - If one of its arguments is tagged with the
DoFn.Element
annotation, then it will be passed the current element being processed; the argument must be of typeInputT
. Note that automatic conversion ofRow
s andDoFn.FieldAccess
parameters are currently unsupported. - If one of its arguments is tagged with the
DoFn.Timestamp
annotation, then it will be passed the timestamp of the current element being processed; the argument must be of typeInstant
. - If one of its arguments is a subtype of
BoundedWindow
, then it will be passed the window of the current element. When applied byParDo
the subtype ofBoundedWindow
must match the type of windows on the inputPCollection
. If the window is not accessed a runner may perform additional optimizations. - If one of its arguments is of type
PaneInfo
, then it will be passed information about the current triggering pane. - If one of the parameters is of type
PipelineOptions
, then it will be passed the options for the current pipeline.
- The return type