java message bus_ServiceBusMessage

Adds a new key value pair to the existing context on Message.

Gets the set of free-form ServiceBusMessage properties which may be used for passing metadata associated with the ServiceBusMessage during Service Bus operations. A common use-case for getApplicationProperties() is to associate serialization hints for the getBody() as an aid to consumers who wish to deserialize the binary data.

Gets the actual payload/data wrapped by the ServiceBusMessage.

The BinaryData wraps byte array and is an abstraction over many different ways it can be represented. It provides many convenience API including APIs to serialize/deserialize object.

If the means for deserializing the raw data is not apparent to consumers, a common technique is to make use of getApplicationProperties() when creating the event, to associate serialization hints as an aid to consumers who wish to deserialize the binary data.

Gets the content type of the message.

Gets a correlation identifier.

Allows an application to specify a context for the message for the purposes of correlation, for example reflecting the MessageId of a message that is being replied to.

Gets the partition key for sending a message to a partitioned entity.

For partitioned entities, setting this value enables assigning related messages to the same internal partition, so that submission sequence order is correctly recorded. The partition is chosen by a hash function over this value and cannot be chosen directly. For session-aware entities, the getSessionId() property overrides this value.

Gets the address of an entity to send replies to.

This optional and application-defined value is a standard way to express a reply path to the receiver of the message. When a sender expects a reply, it sets the value to the absolute or relative path of the queue or topic it expects the reply to be sent to.

Gets or sets a session identifier augmenting the getReplyTo() address.

This value augments the ReplyTo information and specifies which SessionId should be set for the reply when sent to the reply entity.

Gets the scheduled enqueue time of this message.

This value is used for delayed message availability. The message is safely added to the queue, but is not considered active and therefore not retrievable until the scheduled enqueue time. Mind that the message may not be activated (enqueued) at the exact given datetime; the actual activation time depends on the queue's workload and its state.

Gets the session id of the message.

Gets the subject for the message.

Gets the duration before this message expires.

This value is the relative duration after which the message expires, starting from the instant the message has been accepted and stored by the broker, as captured in getScheduledEnqueueTime(). When not set explicitly, the assumed value is the DefaultTimeToLive set for the respective queue or topic. A message-level TimeToLive value cannot be longer than the entity's DefaultTimeToLive setting and it is silently adjusted if it does.

Gets the "to" address.

Gets the partition key for sending a message to a entity via another partitioned transfer entity. If a message is sent via a transfer queue in the scope of a transaction, this value selects the transfer queue partition: This is functionally equivalent to getPartitionKey() and ensures that messages are kept together and in order as they are transferred.

Sets a partition key for sending a message to a partitioned entity

Sets the address of an entity to send replies to.

Gets or sets a session identifier augmenting the getReplyTo() address.

Sets the scheduled enqueue time of this message. A null will not be set. If this value needs to be unset it could be done by value removing from getMessageAnnotations using key AmqpMessageConstant#SCHEDULED_ENQUEUE_UTC_TIME_NAME.

Sets the subject for the message.

Sets the duration of time before this message expires.

Sets the "to" address.

This property is reserved for future use in routing scenarios and presently ignored by the broker itself. Applications can use this value in rule-driven auto-forward chaining scenarios to indicate the intended logical destination of the message.

Sets a via-partition key for sending a message to a destination entity via another partitioned entity