ServiceBusMessage (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.messaging.servicebus.ServiceBusMessage

```
public class ServiceBusMessage
extends Object
```
The data structure encapsulating the message being sent-to Service Bus.
Here's how AMQP message sections map to ServiceBusMessage. For reference, the specification can be found here: AMQP 1.0 specification
1. ServiceBusMessage.getProperties() - AMQPMessage.ApplicationProperties section
2. ServiceBusMessage.getBody() - if AMQPMessage.Body has Data section
Serializing a received ServiceBusMessage with AMQP sections other than ApplicationProperties (with primitive Java types) and Data section is not supported.
See Also:

ServiceBusMessageBatch

Constructor Summary

Constructors
Constructor and Description
`ServiceBusMessage(byte[] body)` Creates a `ServiceBusMessage` containing the `body`.
`ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)` Creates a `ServiceBusMessage` using properties from `receivedMessage`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceBusMessage`	`addContext(String key, Object value)` Adds a new key value pair to the existing context on Message.
`byte[]`	`getBody()` Gets the actual payload/data wrapped by the `ServiceBusMessage`.
`String`	`getContentType()` Gets the content type of the message.
`String`	`getCorrelationId()` Gets a correlation identifier.
`String`	`getLabel()` Gets the label for the message.
`String`	`getMessageId()`
`String`	`getPartitionKey()` Gets the partition key for sending a message to a partitioned entity.
`Map<String,Object>`	`getProperties()` Gets the set of free-form `ServiceBusMessage` properties which may be used for passing metadata associated with the `ServiceBusMessage` during Service Bus operations.
`String`	`getReplyTo()` Gets the address of an entity to send replies to.
`String`	`getReplyToSessionId()` Gets or sets a session identifier augmenting the `ReplyTo` address.
`Instant`	`getScheduledEnqueueTime()` Gets the scheduled enqueue time of this message.
`String`	`getSessionId()` Gets the session id of the message.
`Duration`	`getTimeToLive()` Gets the duration before this message expires.
`String`	`getTo()` Gets the "to" address.
`String`	`getViaPartitionKey()` Gets the partition key for sending a message to a entity via another partitioned transfer entity.
`ServiceBusMessage`	`setContentType(String contentType)` Sets the content type of the `ServiceBusMessage`.
`ServiceBusMessage`	`setCorrelationId(String correlationId)` Sets a correlation identifier.
`ServiceBusMessage`	`setLabel(String label)` Sets the label for the message.
`ServiceBusMessage`	`setMessageId(String messageId)` Sets the message id.
`ServiceBusMessage`	`setPartitionKey(String partitionKey)` Sets a partition key for sending a message to a partitioned entity
`ServiceBusMessage`	`setReplyTo(String replyTo)` Sets the address of an entity to send replies to.
`ServiceBusMessage`	`setReplyToSessionId(String replyToSessionId)` Gets or sets a session identifier augmenting the `ReplyTo` address.
`ServiceBusMessage`	`setScheduledEnqueueTime(Instant scheduledEnqueueTime)` Sets the scheduled enqueue time of this message.
`ServiceBusMessage`	`setSessionId(String sessionId)` Sets the session id.
`ServiceBusMessage`	`setTimeToLive(Duration timeToLive)` Sets the duration of time before this message expires.
`ServiceBusMessage`	`setTo(String to)` Sets the "to" address.
`ServiceBusMessage`	`setViaPartitionKey(String viaPartitionKey)` Sets a via-partition key for sending a message to a destination entity via another partitioned entity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServiceBusMessage
```
public ServiceBusMessage(byte[] body)
```
    Creates a ServiceBusMessage containing the body.
    
    Parameters:
    
    body - The data to set for this ServiceBusMessage.
    
    Throws:
    
    NullPointerException - if body is null.
  - ServiceBusMessage
```
public ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)
```
    Creates a ServiceBusMessage using properties from receivedMessage. This is normally used when a ServiceBusReceivedMessage needs to be sent to another entity.
    
    Parameters:
    
    receivedMessage - The received message to create new message from.
    
    Throws:
    
    NullPointerException - if receivedMessage is null.
- Method Detail
  - getProperties
```
public Map<String,Object> getProperties()
```
    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 properties() is to associate serialization hints for the ServiceBusMessage.getBody() as an aid to consumers who wish to deserialize the binary data.
    
    Returns:
    
    Application properties associated with this ServiceBusMessage.
  - getBody
```
public byte[] getBody()
```
    Gets the actual payload/data wrapped by the ServiceBusMessage.
    If the means for deserializing the raw data is not apparent to consumers, a common technique is to make use of ServiceBusMessage.getProperties() when creating the event, to associate serialization hints as an aid to consumers who wish to deserialize the binary data.
    
    Returns:
    
    A byte array representing the data.
  - getContentType
```
public String getContentType()
```
    Gets the content type of the message.
    
    Returns:
    
    the contentType of the ServiceBusMessage.
  - setContentType
```
public ServiceBusMessage setContentType(String contentType)
```
    Sets the content type of the ServiceBusMessage.
    
    Parameters:
    
    contentType - of the message.
    
    Returns:
    
    The updated ServiceBusMessage.
  - getCorrelationId
```
public String getCorrelationId()
```
    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.
    
    Returns:
    
    correlation id of this message
    
    See Also:
    
    Message Routing and Correlation
  - setCorrelationId
```
public ServiceBusMessage setCorrelationId(String correlationId)
```
    Sets a correlation identifier.
    
    Parameters:
    
    correlationId - correlation id of this message
    
    Returns:
    
    The updated ServiceBusMessage.
    
    See Also:
    
    ServiceBusMessage.getCorrelationId()
  - getLabel
```
public String getLabel()
```
    Gets the label for the message.
    
    Returns:
    
    The label for the message.
  - setLabel
```
public ServiceBusMessage setLabel(String label)
```
    Sets the label for the message.
    
    Parameters:
    
    label - The label to set.
    
    Returns:
    
    The updated ServiceBusMessage object.
  - getMessageId
```
public String getMessageId()
```
    Returns:
    
    Id of the ServiceBusMessage.
  - setMessageId
```
public ServiceBusMessage setMessageId(String messageId)
```
    Sets the message id.
    
    Parameters:
    
    messageId - to be set.
    
    Returns:
    
    The updated ServiceBusMessage.
  - getPartitionKey
```
public String getPartitionKey()
```
    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 sessionId property overrides this value.
    
    Returns:
    
    The partition key of this message
    
    See Also:
    
    Partitioned entities
  - setPartitionKey
```
public ServiceBusMessage setPartitionKey(String partitionKey)
```
    Sets a partition key for sending a message to a partitioned entity
    
    Parameters:
    
    partitionKey - partition key of this message
    
    Returns:
    
    The updated ServiceBusMessage.
    
    See Also:
    
    ServiceBusMessage.getPartitionKey()
  - getReplyTo
```
public String getReplyTo()
```
    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.
    
    Returns:
    
    ReplyTo property value of this message
    
    See Also:
    
    Message Routing and Correlation
  - setReplyTo
```
public ServiceBusMessage setReplyTo(String replyTo)
```
    Sets the address of an entity to send replies to.
    
    Parameters:
    
    replyTo - ReplyTo property value of this message
    
    Returns:
    
    The updated ServiceBusMessage.
    
    See Also:
    
    ServiceBusMessage.getReplyTo()
  - getTo
```
public String getTo()
```
    Gets the "to" address.
    
    Returns:
    
    "To" property value of this message
  - setTo
```
public ServiceBusMessage setTo(String to)
```
    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.
    
    Parameters:
    
    to - To property value of this message
    
    Returns:
    
    The updated ServiceBusMessage.
  - getTimeToLive
```
public Duration getTimeToLive()
```
    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 ServiceBusMessage.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.
    
    Returns:
    
    Time to live duration of this message
    
    See Also:
    
    Message Expiration
  - setTimeToLive
```
public ServiceBusMessage setTimeToLive(Duration timeToLive)
```
    Sets the duration of time before this message expires.
    
    Parameters:
    
    timeToLive - Time to Live duration of this message
    
    Returns:
    
    The updated ServiceBusMessage.
    
    See Also:
    
    ServiceBusMessage.getTimeToLive()
  - getScheduledEnqueueTime
```
public Instant getScheduledEnqueueTime()
```
    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 instant; the actual activation time depends on the queue's workload and its state.
    
    Returns:
    
    the instant at which the message will be enqueued in Azure Service Bus
    
    See Also:
    
    Message Sequencing and Timestamps
  - setScheduledEnqueueTime
```
public ServiceBusMessage setScheduledEnqueueTime(Instant scheduledEnqueueTime)
```
    Sets the scheduled enqueue time of this message.
    
    Parameters:
    
    scheduledEnqueueTime - the instant at which this message should be enqueued in Azure Service Bus.
    
    Returns:
    
    The updated ServiceBusMessage.
    
    See Also:
    
    ServiceBusMessage.getScheduledEnqueueTime()
  - getReplyToSessionId
```
public String getReplyToSessionId()
```
    Gets or sets a session identifier augmenting the ReplyTo address.
    This value augments the ReplyTo information and specifies which SessionId should be set for the reply when sent to the reply entity.
    
    Returns:
    
    ReplyToSessionId property value of this message
    
    See Also:
    
    Message Routing and Correlation
  - setReplyToSessionId
```
public ServiceBusMessage setReplyToSessionId(String replyToSessionId)
```
    Gets or sets a session identifier augmenting the ReplyTo address.
    
    Parameters:
    
    replyToSessionId - ReplyToSessionId property value of this message
    
    Returns:
    
    The updated ServiceBusMessage.
  - getViaPartitionKey
```
public String getViaPartitionKey()
```
    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 ServiceBusMessage.getPartitionKey() and ensures that messages are kept together and in order as they are transferred.
    
    Returns:
    
    partition key on the via queue.
    
    See Also:
    
    Transfers and Send Via
  - setViaPartitionKey
```
public ServiceBusMessage setViaPartitionKey(String viaPartitionKey)
```
    Sets a via-partition key for sending a message to a destination entity via another partitioned entity
    
    Parameters:
    
    viaPartitionKey - via-partition key of this message
    
    Returns:
    
    The updated ServiceBusMessage.
    
    See Also:
    
    ServiceBusMessage.getViaPartitionKey()
  - getSessionId
```
public String getSessionId()
```
    Gets the session id of the message.
    
    Returns:
    
    Session Id of the ServiceBusMessage.
  - setSessionId
```
public ServiceBusMessage setSessionId(String sessionId)
```
    Sets the session id.
    
    Parameters:
    
    sessionId - to be set.
    
    Returns:
    
    The updated ServiceBusMessage.
  - addContext
```
public ServiceBusMessage addContext(String key,
                                    Object value)
```
    Adds a new key value pair to the existing context on Message.
    
    Parameters:
    
    key - The key for this context object
    
    value - The value for this context object.
    
    Returns:
    
    The updated ServiceBusMessage.
    
    Throws:
    
    NullPointerException - if key or value is null.

Class ServiceBusMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceBusMessage

ServiceBusMessage

Method Detail

getProperties

getBody

getContentType

setContentType

getCorrelationId

setCorrelationId

getLabel

setLabel

getMessageId

setMessageId

getPartitionKey

setPartitionKey

getReplyTo

setReplyTo

getTo

setTo

getTimeToLive

setTimeToLive

getScheduledEnqueueTime

setScheduledEnqueueTime

getReplyToSessionId

setReplyToSessionId

getViaPartitionKey

setViaPartitionKey

getSessionId

setSessionId

addContext