org.apache.flink.connector.pulsar.source

Class PulsarSource<OUT>

java.lang.Object

org.apache.flink.connector.pulsar.source.PulsarSource<OUT>

Type Parameters:

OUT - The output type of the source.

All Implemented Interfaces:

Serializable, org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>

@PublicEvolving
public final class PulsarSource<OUT>
extends Object
implements org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>

The Source implementation of Pulsar. Please use a PulsarSourceBuilder to construct a PulsarSource. The following example shows how to create a PulsarSource emitting records of String type.

 PulsarSource<String> source = PulsarSource
     .builder()
     .setTopics(TOPIC1， TOPIC2)
     .setServiceUrl(getServiceUrl())
     .setAdminUrl(getAdminUrl())
     .setSubscriptionName("test")
     .setDeserializationSchema(PulsarDeserializationSchema.flinkSchema(new SimpleStringSchema()))
     .setBounded(StopCursor::defaultStopCursor)
     .build();
 

See PulsarSourceBuilder for more details.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

PulsarSource(SourceConfiguration sourceConfiguration, PulsarSubscriber subscriber, RangeGenerator rangeGenerator, StartCursor startCursor, StopCursor stopCursor, org.apache.flink.api.connector.source.Boundedness boundedness, PulsarDeserializationSchema<OUT> deserializationSchema, org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader) The constructor for PulsarSource, it's package protected for forcing using PulsarSourceBuilder.

Method Summary

Modifier and Type	Method and Description
static <OUT> PulsarSourceBuilder<OUT>	builder() Get a PulsarSourceBuilder to builder a PulsarSource.
org.apache.flink.api.connector.source.SplitEnumerator<PulsarPartitionSplit,PulsarSourceEnumState>	createEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> enumContext)
org.apache.flink.api.connector.source.SourceReader<OUT,PulsarPartitionSplit>	createReader(org.apache.flink.api.connector.source.SourceReaderContext readerContext)
org.apache.flink.api.connector.source.Boundedness	getBoundedness()
org.apache.flink.core.io.SimpleVersionedSerializer<PulsarSourceEnumState>	getEnumeratorCheckpointSerializer()
org.apache.flink.api.common.typeinfo.TypeInformation<OUT>	getProducedType()
org.apache.flink.core.io.SimpleVersionedSerializer<PulsarPartitionSplit>	getSplitSerializer()
org.apache.flink.api.connector.source.SplitEnumerator<PulsarPartitionSplit,PulsarSourceEnumState>	restoreEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> enumContext, PulsarSourceEnumState checkpoint)

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsarSource

public PulsarSource(SourceConfiguration sourceConfiguration,
                    PulsarSubscriber subscriber,
                    RangeGenerator rangeGenerator,
                    StartCursor startCursor,
                    StopCursor stopCursor,
                    org.apache.flink.api.connector.source.Boundedness boundedness,
                    PulsarDeserializationSchema<OUT> deserializationSchema,
                    @Nullable
                    org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader)

The constructor for PulsarSource, it's package protected for forcing using PulsarSourceBuilder.

Method Detail

builder

public static <OUT> PulsarSourceBuilder<OUT> builder()

Get a PulsarSourceBuilder to builder a PulsarSource.

Returns:

a Pulsar source builder.

getBoundedness

public org.apache.flink.api.connector.source.Boundedness getBoundedness()

Specified by:

getBoundedness in interface org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>

createReader

@Internal
public org.apache.flink.api.connector.source.SourceReader<OUT,PulsarPartitionSplit> createReader(org.apache.flink.api.connector.source.SourceReaderContext readerContext)
                                                                                                    throws Exception

Specified by:

createReader in interface org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>

Throws:

Exception

createEnumerator

@Internal
public org.apache.flink.api.connector.source.SplitEnumerator<PulsarPartitionSplit,PulsarSourceEnumState> createEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> enumContext)

Specified by:

createEnumerator in interface org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>

restoreEnumerator

@Internal
public org.apache.flink.api.connector.source.SplitEnumerator<PulsarPartitionSplit,PulsarSourceEnumState> restoreEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> enumContext,
                                                                                                                                     PulsarSourceEnumState checkpoint)

Specified by:

restoreEnumerator in interface org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>

getSplitSerializer

@Internal
public org.apache.flink.core.io.SimpleVersionedSerializer<PulsarPartitionSplit> getSplitSerializer()

Specified by:

getSplitSerializer in interface org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>

getEnumeratorCheckpointSerializer

@Internal
public org.apache.flink.core.io.SimpleVersionedSerializer<PulsarSourceEnumState> getEnumeratorCheckpointSerializer()

Specified by:

getEnumeratorCheckpointSerializer in interface org.apache.flink.api.connector.source.Source<OUT,PulsarPartitionSplit,PulsarSourceEnumState>

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<OUT> getProducedType()

Specified by:

getProducedType in interface org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>