io.micronaut.pulsar.annotation

Annotation Type PulsarProducer

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Around
 @Introduction
 @Type(value=PulsarProducerAdvice.class)
public @interface PulsarProducer

Marks a method that should produce values to Pulsar topics on call.

Since:

1.0

Author:

Haris Secic

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoUpdatePartition
boolean	batching
int	batchingMaxBytes Default 128KB.
int	batchingMaxMessages
boolean	blockQueue
boolean	chunking If this is enabled batching should be disabled.
org.apache.pulsar.client.api.CompressionType	compressionType
String	encryptionKey
org.apache.pulsar.client.api.HashingScheme	hashingScheme
long	initialSequenceId
org.apache.pulsar.common.schema.KeyValueEncodingType	keyEncoding If no MessageKey annotated method argument is detected this attribute is ignored and message is treated as simple - without a key.
MessageSchema	keySchema
org.apache.pulsar.client.api.MessageRoutingMode	messageRoutingMode
boolean	multiSchema
String	producerName
MessageSchema	schema
boolean	sendBefore Defaults to false.
@Pattern(regexp="((non-)?persistent://)?((\\w+(-|\\w+)*\\w/)|(\\$\\{tenant\\}))(\\w+(-|\\w+)*\\w/)\\w+(-|\\w+)*\\w") String	topic
String	value

Element Detail

value

@AliasFor(member="topic")
public abstract String value

Returns:

Same as topic()

Default:

""

producerName

public abstract String producerName

Returns:

Producer name.

Default:

""

topic

@AliasFor(member="value")
 @Pattern(regexp="((non-)?persistent://)?((\\w+(-|\\w+)*\\w/)|(\\$\\{tenant\\}))(\\w+(-|\\w+)*\\w/)\\w+(-|\\w+)*\\w")
public abstract @Pattern(regexp="((non-)?persistent://)?((\\w+(-|\\w+)*\\w/)|(\\$\\{tenant\\}))(\\w+(-|\\w+)*\\w/)\\w+(-|\\w+)*\\w") String topic

Returns:

Topic to produce messages to

Default:

""

schema

public abstract MessageSchema schema

Returns:

Type of message serialization.

Default:

io.micronaut.pulsar.MessageSchema.BYTES

keySchema

public abstract MessageSchema keySchema

Returns:

Type of message key serialization.

Default:

io.micronaut.pulsar.MessageSchema.BYTES

keyEncoding

public abstract org.apache.pulsar.common.schema.KeyValueEncodingType keyEncoding

If no MessageKey annotated method argument is detected this attribute is ignored and message is treated as simple - without a key.

Returns:

Whether key will be in the message payload or separate.

Default:

org.apache.pulsar.common.schema.KeyValueEncodingType.INLINE

compressionType

public abstract org.apache.pulsar.client.api.CompressionType compressionType

Returns:

Compression type.

Default:

org.apache.pulsar.client.api.CompressionType.NONE

messageRoutingMode

public abstract org.apache.pulsar.client.api.MessageRoutingMode messageRoutingMode

Returns:

Message routing mode.

Default:

org.apache.pulsar.client.api.MessageRoutingMode.RoundRobinPartition

multiSchema

public abstract boolean multiSchema

Returns:

Produce messages of different schemas than specified at creation time

Default:

true

autoUpdatePartition

public abstract boolean autoUpdatePartition

Returns:

Discover new partitions at runtime

Default:

true

blockQueue

public abstract boolean blockQueue

Returns:

Multiple calls to send and sendAsync will block if queue full

Default:

false

batching

public abstract boolean batching

Returns:

Enabled automatic batching of messages

Default:

true

batchingMaxMessages

public abstract int batchingMaxMessages

Returns:

Max messages in one batch

Default:

1000

batchingMaxBytes

public abstract int batchingMaxBytes

Default 128KB.

Returns:

Max bytes per batch

Default:

131072

chunking

public abstract boolean chunking

If this is enabled batching should be disabled.

Returns:

Split messages in chunks if bigger than max allowed size.

Default:

false

encryptionKey

public abstract String encryptionKey

Returns:

Encryption key to add

Default:

""

initialSequenceId

public abstract long initialSequenceId

Returns:

Starting sequence ID for producer

Default:

-9223372036854775808L

hashingScheme

public abstract org.apache.pulsar.client.api.HashingScheme hashingScheme

Returns:

Change hashing scheme used to choose partition

Default:

org.apache.pulsar.client.api.HashingScheme.JavaStringHash

sendBefore

public abstract boolean sendBefore

Defaults to false. Will be used to determine whether to send message prior to executing method code or after.

Returns:

Whether to send the message before calling actual implementation.

Default:

false