io.micronaut.pulsar.annotation

Annotation Type PulsarReader

@Documented
 @Retention(value=RUNTIME)
 @Target(value={PARAMETER,FIELD})
public @interface PulsarReader

Create and inject Pulsar reader into field.

Since:

1.0

Author:

Haris Secic

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	readerName
MessageSchema	schema Defaults to MessageSchema.BYTES as default value for Pulsar Schema is byte[].
boolean	startMessageLatest
boolean	subscribeAsync By default, reader should subscribe in non-blocking manner using default CompletableFuture of ConsumerBuilder.subscribeAsync().
@Pattern(regexp="((non-)?persistent://)?(\\w+(-|\\w+)*\\w/){2}\\w+(-|\\w+)*\\w") java.lang.String	topic Only single topic subscription possible for readers.
java.lang.String	value

Element Detail

value

@AliasFor(member="topic") @AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,member="value")
public abstract java.lang.String value

Returns:

topic name to listen to

See Also:

topic()

Default:

""

topic

@AliasFor(member="value") @AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,member="value")
 @Pattern(regexp="((non-)?persistent://)?(\\w+(-|\\w+)*\\w/){2}\\w+(-|\\w+)*\\w")
public abstract @Pattern(regexp="((non-)?persistent://)?(\\w+(-|\\w+)*\\w/){2}\\w+(-|\\w+)*\\w") java.lang.String topic

Only single topic subscription possible for readers.

Returns:

topic name to listen to

Default:

""

schema

public abstract MessageSchema schema

Defaults to MessageSchema.BYTES as default value for Pulsar Schema is byte[].

Returns:

Schema to use with pulsar topic consumer

Default:

io.micronaut.pulsar.MessageSchema.BYTES

readerName

public abstract java.lang.String readerName

Returns:

Reader name.

Default:

""

subscribeAsync

public abstract boolean subscribeAsync

By default, reader should subscribe in non-blocking manner using default CompletableFuture of ConsumerBuilder.subscribeAsync().

If blocking is set to false, application thread initializing it will block until consumer is successfully subscribed.

Returns:

Should the consumer subscribe in async manner or blocking

Default:

true

startMessageLatest

public abstract boolean startMessageLatest

Returns:

Whether to position reader to the newest available message in queue or not.

Default:

true