org.apache.beam.sdk.io.gcp.pubsub

Class TestPubsubSignal

java.lang.Object

org.apache.beam.sdk.io.gcp.pubsub.TestPubsubSignal

All Implemented Interfaces:

org.junit.rules.TestRule

public class TestPubsubSignal
extends java.lang.Object
implements org.junit.rules.TestRule

Test rule which observes elements of the PCollection and checks whether they match the success criteria.

Uses a random temporary Pubsub topic for synchronization.

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, Description description)
static TestPubsubSignal	create() Creates an instance of this rule.
PTransform<PBegin,PDone>	signalStart() Outputs a message that the pipeline has started.
<T> PTransform<PCollection<? extends T>,POutput>	signalSuccessWhen(Coder<T> coder, SerializableFunction<java.util.Set<T>,java.lang.Boolean> successPredicate) Invocation of signalSuccessWhen(Coder, SerializableFunction, SerializableFunction) with Object.toString() as the formatter.
<T> PTransform<PCollection<? extends T>,POutput>	signalSuccessWhen(Coder<T> coder, SerializableFunction<T,java.lang.String> formatter, SerializableFunction<java.util.Set<T>,java.lang.Boolean> successPredicate) Outputs a success message when successPredicate is evaluated to true.
Supplier<java.lang.Void>	waitForStart(Duration duration) Future that waits for a start signal for duration.
void	waitForSuccess(Duration duration) Wait for a success signal for duration.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TestPubsubSignal create()

Creates an instance of this rule.

Loads GCP configuration from TestPipelineOptions.

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               Description description)

Specified by:

apply in interface org.junit.rules.TestRule

signalStart

public PTransform<PBegin,PDone> signalStart()

Outputs a message that the pipeline has started.

signalSuccessWhen

public <T> PTransform<PCollection<? extends T>,POutput> signalSuccessWhen(Coder<T> coder,
                                                                          SerializableFunction<T,java.lang.String> formatter,
                                                                          SerializableFunction<java.util.Set<T>,java.lang.Boolean> successPredicate)

Outputs a success message when successPredicate is evaluated to true.

successPredicate is a SerializableFunction that accepts a set of currently captured events and returns true when the set satisfies the success criteria.

If successPredicate is evaluated to false, then it will be re-evaluated when next event becomes available.

If successPredicate is evaluated to true, then a success will be signaled and waitForSuccess(Duration) will unblock.

If successPredicate throws, then failure will be signaled and waitForSuccess(Duration) will unblock.

signalSuccessWhen

public <T> PTransform<PCollection<? extends T>,POutput> signalSuccessWhen(Coder<T> coder,
                                                                          SerializableFunction<java.util.Set<T>,java.lang.Boolean> successPredicate)

Invocation of signalSuccessWhen(Coder, SerializableFunction, SerializableFunction) with Object.toString() as the formatter.

waitForStart

public Supplier<java.lang.Void> waitForStart(Duration duration)
                                      throws java.io.IOException

Future that waits for a start signal for duration.

This future must be created before running the pipeline. A subscription must exist prior to the start signal being published, which occurs immediately upon pipeline startup.

Throws:

java.io.IOException

waitForSuccess

public void waitForSuccess(Duration duration)
                    throws java.io.IOException

Wait for a success signal for duration.

Throws:

java.io.IOException