TypedMessageBuilder (Pulsar Client

所有超级接口:: Serializable

public interface TypedMessageBuilder<T>
extends Serializable

Message builder that constructs a message to be published through a producer. Usage example:


 producer.newMessage().key(myKey).value(myValue).send();

字段概要

字段
限定符和类型	字段和说明
`static String`	`CONF_DELIVERY_AFTER_SECONDS`
`static String`	`CONF_DELIVERY_AT`
`static String`	`CONF_DISABLE_REPLICATION`
`static String`	`CONF_EVENT_TIME`
`static String`	`CONF_KEY`
`static String`	`CONF_PROPERTIES`
`static String`	`CONF_REPLICATION_CLUSTERS`
`static String`	`CONF_SEQUENCE_ID`

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`TypedMessageBuilder<T>`	`deliverAfter(long delay, TimeUnit unit)` Request to deliver the message only after the specified relative delay.
`TypedMessageBuilder<T>`	`deliverAt(long timestamp)` Deliver the message only at or after the specified absolute timestamp.
`TypedMessageBuilder<T>`	`disableReplication()` Disable geo-replication for this message.
`TypedMessageBuilder<T>`	`eventTime(long timestamp)` Set the event time for a given message.
`TypedMessageBuilder<T>`	`key(String key)` Sets the key of the message for routing policy
`TypedMessageBuilder<T>`	`keyBytes(byte[] key)` Sets the bytes of the key of the message for routing policy.
`TypedMessageBuilder<T>`	`loadConf(Map<String,Object> config)` Configure the `TypedMessageBuilder` from a config map, as an alternative compared to call the individual builder methods.
`TypedMessageBuilder<T>`	`orderingKey(byte[] orderingKey)` Sets the ordering key of the message for message dispatch in `SubscriptionType.Key_Shared` mode.
`TypedMessageBuilder<T>`	`properties(Map<String,String> properties)` Add all the properties in the provided map
`TypedMessageBuilder<T>`	`property(String name, String value)` Sets a new property on a message.
`TypedMessageBuilder<T>`	`replicationClusters(List<String> clusters)` Override the geo-replication clusters for this message.
`MessageId`	`send()` Send a message synchronously.
`CompletableFuture<MessageId>`	`sendAsync()` Send a message asynchronously This method returns a future that can be used to track the completion of the send operation and yields the `MessageId` assigned by the broker to the published message.
`TypedMessageBuilder<T>`	`sequenceId(long sequenceId)` Specify a custom sequence id for the message being published.
`TypedMessageBuilder<T>`	`value(T value)` Set a domain object on the message

字段详细资料
- CONF_KEY
```
static final String CONF_KEY
```
  另请参阅:
  
  常量字段值
- CONF_PROPERTIES
```
static final String CONF_PROPERTIES
```
  另请参阅:
  
  常量字段值
- CONF_EVENT_TIME
```
static final String CONF_EVENT_TIME
```
  另请参阅:
  
  常量字段值
- CONF_SEQUENCE_ID
```
static final String CONF_SEQUENCE_ID
```
  另请参阅:
  
  常量字段值
- CONF_REPLICATION_CLUSTERS
```
static final String CONF_REPLICATION_CLUSTERS
```
  另请参阅:
  
  常量字段值
- CONF_DISABLE_REPLICATION
```
static final String CONF_DISABLE_REPLICATION
```
  另请参阅:
  
  常量字段值
- CONF_DELIVERY_AFTER_SECONDS
```
static final String CONF_DELIVERY_AFTER_SECONDS
```
  另请参阅:
  
  常量字段值
- CONF_DELIVERY_AT
```
static final String CONF_DELIVERY_AT
```
  另请参阅:
  
  常量字段值

方法详细资料

send
```
MessageId send()
        throws PulsarClientException
```
Send a message synchronously.
This method will block until the message is successfully published and returns the MessageId assigned by the broker to the published message.
Example:
```
 MessageId msgId = producer.newMessage()
                  .key(myKey)
                  .value(myValue)
                  .send();
 System.out.println("Published message: " + msgId);
 
```
返回:

the MessageId assigned by the broker to the published message.

抛出:

PulsarClientException

sendAsync
```
CompletableFuture<MessageId> sendAsync()
```
Send a message asynchronously
This method returns a future that can be used to track the completion of the send operation and yields the MessageId assigned by the broker to the published message.
Example:
```
 producer.newMessage()
                  .value(myValue)
                  .sendAsync().thenAccept(messageId -> {
    System.out.println("Published message: " + messageId);
 }).exceptionally(e -> {
    System.out.println("Failed to publish " + e);
    return null;
 });
 
```
When the producer queue is full, by default this method will complete the future with an exception PulsarClientException.ProducerQueueIsFullError
See ProducerBuilder.maxPendingMessages(int) to configure the producer queue size and ProducerBuilder.blockIfQueueFull(boolean) to change the blocking behavior.
参数:

message - a message

返回:

a future that can be used to track when the message will have been safely persisted

key
```
TypedMessageBuilder<T> key(String key)
```
Sets the key of the message for routing policy

参数:

key - the partitioning key for the message

返回:

the message builder instance

keyBytes
```
TypedMessageBuilder<T> keyBytes(byte[] key)
```
Sets the bytes of the key of the message for routing policy. Internally the bytes will be base64 encoded.

参数:

key - routing key for message, in byte array form

返回:

the message builder instance

orderingKey
```
TypedMessageBuilder<T> orderingKey(byte[] orderingKey)
```
Sets the ordering key of the message for message dispatch in SubscriptionType.Key_Shared mode. Partition key Will be used if ordering key not specified

参数:

orderingKey - the ordering key for the message

返回:

the message builder instance

value
```
TypedMessageBuilder<T> value(T value)
```
Set a domain object on the message

参数:

value - the domain object

返回:

the message builder instance

property
```
TypedMessageBuilder<T> property(String name,
                                String value)
```
Sets a new property on a message.

参数:

name - the name of the property

value - the associated value

返回:

the message builder instance

properties
```
TypedMessageBuilder<T> properties(Map<String,String> properties)
```
Add all the properties in the provided map

返回:

the message builder instance

eventTime
```
TypedMessageBuilder<T> eventTime(long timestamp)
```
Set the event time for a given message.
Applications can retrieve the event time by calling Message.getEventTime().
Note: currently pulsar doesn't support event-time based index. so the subscribers can't seek the messages by event time.

返回:

the message builder instance

sequenceId
```
TypedMessageBuilder<T> sequenceId(long sequenceId)
```
Specify a custom sequence id for the message being published.
The sequence id can be used for deduplication purposes and it needs to follow these rules:
1. sequenceId >= 0
2. Sequence id for a message needs to be greater than sequence id for earlier messages: sequenceId(N+1) > sequenceId(N)
3. It's not necessary for sequence ids to be consecutive. There can be holes between messages. Eg. the sequenceId could represent an offset or a cumulative size.
参数:

sequenceId - the sequence id to assign to the current message

返回:

the message builder instance

replicationClusters
```
TypedMessageBuilder<T> replicationClusters(List<String> clusters)
```
Override the geo-replication clusters for this message.

参数:

clusters -

返回:

the message builder instance

disableReplication
```
TypedMessageBuilder<T> disableReplication()
```
Disable geo-replication for this message.

返回:

the message builder instance

deliverAt
```
TypedMessageBuilder<T> deliverAt(long timestamp)
```
Deliver the message only at or after the specified absolute timestamp.
The timestamp is milliseconds and based on UTC (eg: System.currentTimeMillis().
Note: messages are only delivered with delay when a consumer is consuming through a SubscriptionType.Shared subscription. With other subscription types, the messages will still be delivered immediately.

参数:

timestamp - absolute timestamp indicating when the message should be delivered to consumers

返回:

the message builder instance

deliverAfter
```
TypedMessageBuilder<T> deliverAfter(long delay,
                                    TimeUnit unit)
```
Request to deliver the message only after the specified relative delay.
Note: messages are only delivered with delay when a consumer is consuming through a SubscriptionType.Shared subscription. With other subscription types, the messages will still be delivered immediately.

参数:

delay - the amount of delay before the message will be delivered

unit - the time unit for the delay

返回:

the message builder instance

loadConf

TypedMessageBuilder<T> loadConf(Map<String,Object> config)

Configure the TypedMessageBuilder from a config map, as an alternative compared to call the individual builder methods.

The "value" of the message itself cannot be set on the config map.

Example:


 Map<String, Object> conf = new HashMap<>();
 conf.put("key", "my-key");
 conf.put("eventTime", System.currentTimeMillis());

 producer.newMessage()
             .value("my-message")
             .loadConf(conf)
             .send();

The available options are:

Constant	Name	Type	Doc
`CONF_KEY`	`key`	`String`	`key(String)`
`CONF_PROPERTIES`	`properties`	`Map<String,String>`	`properties(Map)`
`CONF_EVENT_TIME`	`eventTime`	`long`	`eventTime(long)`
`CONF_SEQUENCE_ID`	`sequenceId`	`long`	`sequenceId(long)`
`CONF_REPLICATION_CLUSTERS`	`replicationClusters`	`List<String>`	`replicationClusters(List)`
`CONF_DISABLE_REPLICATION`	`disableReplication`	`boolean`	`disableReplication()`
`CONF_DELIVERY_AFTER_SECONDS`	`deliverAfterSeconds`	`long`	`deliverAfter(long, TimeUnit)`
`CONF_DELIVERY_AT`	`deliverAt`	`long`	`deliverAt(long)`

参数:: config - a map with the configuration options for the message
返回:: the message builder instance

接口 TypedMessageBuilder<T>

字段概要

方法概要

字段详细资料

CONF_KEY

CONF_PROPERTIES

CONF_EVENT_TIME

CONF_SEQUENCE_ID

CONF_REPLICATION_CLUSTERS

CONF_DISABLE_REPLICATION

CONF_DELIVERY_AFTER_SECONDS

CONF_DELIVERY_AT

方法详细资料

send

sendAsync

key

keyBytes

orderingKey

value

property

properties

eventTime

sequenceId

replicationClusters

disableReplication

deliverAt

deliverAfter

loadConf