org.apache.flink.streaming.connectors.gcp.pubsub

Class PubSubSink<IN>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

org.apache.flink.streaming.connectors.gcp.pubsub.PubSubSink<IN>

Type Parameters:

IN - type of PubSubSink messages to write

All Implemented Interfaces:

Serializable, Function, RichFunction, CheckpointedFunction, SinkFunction<IN>

public class PubSubSink<IN>
extends RichSinkFunction<IN>
implements CheckpointedFunction

A sink function that outputs to PubSub.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PubSubSink.ProjectNameBuilder<IN> Part of PubSubSink.PubSubSinkBuilder to set required fields.
static class	PubSubSink.PubSubSinkBuilder<IN> PubSubSinkBuilder to create a PubSubSink.
static class	PubSubSink.SerializationSchemaBuilder Part of PubSubSink.PubSubSinkBuilder to set required fields.
static interface	PubSubSink.TopicNameBuilder<IN> Part of PubSubSink.PubSubSinkBuilder to set required fields.

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

SinkFunction.Context<T>

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
void	initializeState(FunctionInitializationContext context) This method is called when the parallel function instance is created during distributed execution.
void	invoke(IN message, SinkFunction.Context context) Writes the given value to the sink.
static PubSubSink.SerializationSchemaBuilder	newBuilder() Create a builder for a new PubSubSink.
void	open(Configuration configuration) Initialization method for the function.
void	snapshotState(FunctionSnapshotContext context) This method is called when a snapshot for a checkpoint is requested.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

invoke

Method Detail

open

public void open(Configuration configuration)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

configuration - The configuration containing the parameters attached to the contract.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

invoke

public void invoke(IN message,
                   SinkFunction.Context context)
            throws Exception

Description copied from interface: SinkFunction

Writes the given value to the sink. This function is called for every record.

You have to override this method when implementing a SinkFunction, this is a default method for backward compatibility with the old-style method only.

Specified by:

invoke in interface SinkFunction<IN>

Parameters:

message - The input record.

context - Additional context about the input record.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.

newBuilder

public static PubSubSink.SerializationSchemaBuilder newBuilder()

Create a builder for a new PubSubSink.

Returns:

a new PubSubSinkBuilder instance

snapshotState

public void snapshotState(FunctionSnapshotContext context)
                   throws Exception

Description copied from interface: CheckpointedFunction

This method is called when a snapshot for a checkpoint is requested. This acts as a hook to the function to ensure that all state is exposed by means previously offered through FunctionInitializationContext when the Function was initialized, or offered now by FunctionSnapshotContext itself.

Specified by:

snapshotState in interface CheckpointedFunction

Parameters:

context - the context for drawing a snapshot of the operator

Throws:

Exception - Thrown, if state could not be created ot restored.

initializeState

public void initializeState(FunctionInitializationContext context)
                     throws Exception

Description copied from interface: CheckpointedFunction

This method is called when the parallel function instance is created during distributed execution. Functions typically set up their state storing data structures in this method.

Specified by:

initializeState in interface CheckpointedFunction

Parameters:

context - the context for initializing the operator

Throws:

Exception - Thrown, if state could not be created ot restored.