Package org.springframework.pulsar.core

Class PulsarTemplate.SendMessageBuilderImpl<T>

java.lang.Object

org.springframework.pulsar.core.PulsarTemplate.SendMessageBuilderImpl<T>

All Implemented Interfaces:

PulsarOperations.SendMessageBuilder<T>

Enclosing class:

PulsarTemplate<T>

public static class PulsarTemplate.SendMessageBuilderImpl<T>
extends Object
implements PulsarOperations.SendMessageBuilder<T>

Method Summary

Modifier and Type	Method	Description
org.apache.pulsar.client.api.MessageId	send()	Send the message in a blocking manner using the configured specification.
CompletableFuture<org.apache.pulsar.client.api.MessageId>	sendAsync()	Uses the configured specification to send the message in a non-blocking manner.
PulsarOperations.SendMessageBuilder<T>	withEncryptionKeys(Collection<String> encryptionKeys)	Specify the encryption keys to use.
PulsarOperations.SendMessageBuilder<T>	withMessageCustomizer(TypedMessageBuilderCustomizer<T> messageCustomizer)	Specifies the message customizer to use to further configure the message.
PulsarOperations.SendMessageBuilder<T>	withProducerCustomizer(ProducerBuilderCustomizer<T> producerCustomizer)	Specifies the customizer to use to further configure the producer builder.
PulsarOperations.SendMessageBuilder<T>	withSchema(org.apache.pulsar.client.api.Schema<T> schema)	Specify the schema to use when sending the message.
PulsarOperations.SendMessageBuilder<T>	withTopic(String topic)	Specify the topic to send the message to.

Methods inherited from class java.lang.Object

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

Method Details

withTopic

public PulsarOperations.SendMessageBuilder<T> withTopic(String topic)

Description copied from interface: PulsarOperations.SendMessageBuilder

Specify the topic to send the message to.

Specified by:

withTopic in interface PulsarOperations.SendMessageBuilder<T>

Parameters:

topic - the destination topic

Returns:

the current builder with the destination topic specified

withSchema

public PulsarOperations.SendMessageBuilder<T> withSchema(org.apache.pulsar.client.api.Schema<T> schema)

Description copied from interface: PulsarOperations.SendMessageBuilder

Specify the schema to use when sending the message.

Specified by:

withSchema in interface PulsarOperations.SendMessageBuilder<T>

Parameters:

schema - the schema to use

Returns:

the current builder with the schema specified

withEncryptionKeys

public PulsarOperations.SendMessageBuilder<T> withEncryptionKeys(Collection<String> encryptionKeys)

Description copied from interface: PulsarOperations.SendMessageBuilder

Specify the encryption keys to use.

Specified by:

withEncryptionKeys in interface PulsarOperations.SendMessageBuilder<T>

Parameters:

encryptionKeys - the encryption keys

Returns:

the current builder with the encryption keys specified

withMessageCustomizer

public PulsarOperations.SendMessageBuilder<T> withMessageCustomizer(TypedMessageBuilderCustomizer<T> messageCustomizer)

Description copied from interface: PulsarOperations.SendMessageBuilder

Specifies the message customizer to use to further configure the message.

Specified by:

withMessageCustomizer in interface PulsarOperations.SendMessageBuilder<T>

Parameters:

messageCustomizer - the message customizer

Returns:

the current builder with the message customizer specified

withProducerCustomizer

public PulsarOperations.SendMessageBuilder<T> withProducerCustomizer(ProducerBuilderCustomizer<T> producerCustomizer)

Description copied from interface: PulsarOperations.SendMessageBuilder

Specifies the customizer to use to further configure the producer builder.

Specified by:

withProducerCustomizer in interface PulsarOperations.SendMessageBuilder<T>

Parameters:

producerCustomizer - the producer builder customizer

Returns:

the current builder with the producer builder customizer specified

send

public org.apache.pulsar.client.api.MessageId send()
                                            throws org.apache.pulsar.client.api.PulsarClientException

Description copied from interface: PulsarOperations.SendMessageBuilder

Send the message in a blocking manner using the configured specification.

Specified by:

send in interface PulsarOperations.SendMessageBuilder<T>

Returns:

the id assigned by the broker to the published message

Throws:

org.apache.pulsar.client.api.PulsarClientException - if an error occurs

sendAsync

public CompletableFuture<org.apache.pulsar.client.api.MessageId> sendAsync()
                                                                    throws org.apache.pulsar.client.api.PulsarClientException

Description copied from interface: PulsarOperations.SendMessageBuilder

Uses the configured specification to send the message in a non-blocking manner.

Specified by:

sendAsync in interface PulsarOperations.SendMessageBuilder<T>

Returns:

a future that holds the id assigned by the broker to the published message

Throws:

org.apache.pulsar.client.api.PulsarClientException - if an error occurs