com.google.cloud.dataflow.sdk.transforms

Class RateLimiting.RateLimitingDoFn<I,O>

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.DoFn<I,O>

com.google.cloud.dataflow.sdk.transforms.RateLimiting.RateLimitingDoFn<I,O>

Type Parameters:

I - the type of the (main) input elements

O - the type of the (main) output elements

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

RateLimiting

public static class RateLimiting.RateLimitingDoFn<I,O>
extends DoFn<I,O>

A rate-limiting DoFn wrapper.

See Also:

RateLimiting.perWorker(DoFn), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.dataflow.sdk.transforms.DoFn

DoFn.Context, DoFn.KeyedState, DoFn.ProcessContext, DoFn.RequiresKeyedState, DoFn.RequiresWindowAccess

Constructor Summary

Constructors

Constructor and Description
RateLimiting.RateLimitingDoFn(DoFn<I,O> doFn, double rateLimit, int maxParallelism)

Method Summary

Methods

Modifier and Type	Method and Description
void	finishBundle(DoFn.Context c) Finishes processing this batch of elements.
void	processElement(DoFn.ProcessContext c) Processes an input element.
void	startBundle(DoFn.Context c) Prepares this DoFn instance for processing a batch of elements.

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.DoFn

getAllowedTimestampSkew

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiting.RateLimitingDoFn

public RateLimiting.RateLimitingDoFn(DoFn<I,O> doFn,
                             double rateLimit,
                             int maxParallelism)

Method Detail

startBundle

public void startBundle(DoFn.Context c)
                 throws java.lang.Exception

Description copied from class: DoFn

Prepares this DoFn instance for processing a batch of elements.

By default, does nothing.

Overrides:

startBundle in class DoFn<I,O>

Throws:

java.lang.Exception

processElement

public void processElement(DoFn.ProcessContext c)
                    throws java.lang.Exception

Description copied from class: DoFn

Processes an input element.

Specified by:

processElement in class DoFn<I,O>

Throws:

java.lang.Exception

finishBundle

public void finishBundle(DoFn.Context c)
                  throws java.lang.Exception

Description copied from class: DoFn

Finishes processing this batch of elements. This DoFn instance will be thrown away after this operation returns.

By default, does nothing.

Overrides:

finishBundle in class DoFn<I,O>

Throws:

java.lang.Exception