IMessage (Azure SDK for Java Reference Documentation)

All Known Implementing Classes:

Message
```
public interface IMessage
```
Represents the message that is exchanged between Azure Service Bus and its clients.

Since:

1.0

See Also:

Messages, Payloads, and Serialization

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`IMessage`	`createCopy()` Creates a shallow copy of this message.
`byte[]`	`getBody()` Deprecated. Message body need not just a byte array. Replaced by `getMessageBody()`
`String`	`getContentType()` Gets the content type of this message.
`String`	`getCorrelationId()` Gets a correlation identifier.
`String`	`getDeadLetterSource()` Gets the name of the queue or subscription that this message was enqueued on, before it was deadlettered.
`long`	`getDeliveryCount()` Gets the number of the times this message was delivered to clients.
`Instant`	`getEnqueuedTimeUtc()` Gets the instant at which this message was enqueued in Azure Service Bus.
`Instant`	`getExpiresAtUtc()` Gets the instant at which this message will expire.
`String`	`getLabel()` Gets the application specific message label.
`Instant`	`getLockedUntilUtc()` Gets the instant at which the lock of this message expires.
`UUID`	`getLockToken()` Gets the lock token for the current message.
`MessageBody`	`getMessageBody()` Gets the body of this message.
`String`	`getMessageId()` Gets the Id of this message.
`String`	`getPartitionKey()` Gets the partition key for sending a message to a partitioned entity.
`Map<String,Object>`	`getProperties()` Gets the map of user application properties of this message.
`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`	`getScheduledEnqueuedTimeUtc()` Deprecated. Replaced by `getScheduledEnqueueTimeUtc()`
`Instant`	`getScheduledEnqueueTimeUtc()` Gets the scheduled enqueue time of this message.
`long`	`getSequenceNumber()` Gets the unique number assigned to a message by Service Bus.
`String`	`getSessionId()` Gets the session identifier for a session-aware entity.
`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.
`void`	`setBody(byte[] body)` Deprecated. Message body need not just a byte array. Replaced by `setMessageBody(MessageBody)`
`void`	`setContentType(String contentType)` Sets the content type of this message.
`void`	`setCorrelationId(String correlationId)` Sets a correlation identifier.
`void`	`setLabel(String label)` Sets an application specific message label.
`void`	`setMessageBody(MessageBody body)` Sets the body of this message.
`void`	`setMessageId(String messageId)` Sets the Id of this message.
`void`	`setPartitionKey(String partitionKey)` Sets a partition key for sending a message to a partitioned entity
`void`	`setProperties(Map<String,Object> properties)` Sets the map of user application properties of this message.
`void`	`setReplyTo(String replyTo)` Sets the address of an entity to send replies to.
`void`	`setReplyToSessionId(String replyToSessionId)` Gets or sets a session identifier augmenting the `ReplyTo` address.
`void`	`setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc)` Deprecated. Replaced by `setScheduledEnqueueTimeUtc(Instant)`
`void`	`setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc)` Sets the scheduled enqueue time of this message.
`void`	`setSessionId(String sessionId)` Sets the session identifier for a session-aware entity.
`void`	`setTimeToLive(Duration timeToLive)` Sets the duration of time before this message expires.
`void`	`setTo(String to)` Sets the "to" address.
`void`	`setViaPartitionKey(String viaPartitionKey)` Sets a via-partition key for sending a message to a destination entity via another partitioned entity

- Method Detail
  - getDeliveryCount
```
long getDeliveryCount()
```
    Gets the number of the times this message was delivered to clients. The count is incremented when a message lock expires, or the message is explicitly abandoned by the receiver. This property is read-only.
    
    Returns:
    
    delivery count of this message.
    
    See Also:
    
    Message transfers, locks, and settlement.
  - getMessageId
```
String getMessageId()
```
    Gets the Id of this message. The message identifier is an application-defined value that uniquely identifies the message and its payload. The identifier is a free-form string and can reflect a GUID or an identifier derived from the application context. If enabled, the duplicate detection feature identifies and removes second and further submissions of messages with the same MessageId.
    
    Returns:
    
    Id of this message
  - setMessageId
```
void setMessageId(String messageId)
```
    Sets the Id of this message.
    
    Parameters:
    
    messageId - Id of this message
    
    See Also:
    
    getMessageId()
  - getTimeToLive
```
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 getEnqueuedTimeUtc. 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
```
void setTimeToLive(Duration timeToLive)
```
    Sets the duration of time before this message expires.
    
    Parameters:
    
    timeToLive - Time to Live duration of this message
    
    See Also:
    
    getTimeToLive()
  - getContentType
```
String getContentType()
```
    Gets the content type of this message. Optionally describes the payload of the message, with a descriptor following the format of RFC2045, Section 5, for example "application/json". Note that content type is not same as message body type.
    
    Returns:
    
    content type of this message
  - setContentType
```
void setContentType(String contentType)
```
    Sets the content type of this message.
    
    Parameters:
    
    contentType - content type of this message
    
    See Also:
    
    getContentType()
  - getExpiresAtUtc
```
Instant getExpiresAtUtc()
```
    Gets the instant at which this message will expire. The value is the UTC instant for when the message is scheduled for removal and will no longer available for retrieval from the entity due to expiration. Expiry is controlled by the TimeToLive property. This property is computed from EnqueuedTimeUtc+TimeToLive.
    
    Returns:
    
    instant at which this message expires
    
    See Also:
    
    Message Expiration
  - getLockedUntilUtc
```
Instant getLockedUntilUtc()
```
    Gets the instant at which the lock of this message expires. For messages retrieved under a lock (peek-lock receive mode, not pre-settled) this property reflects the UTC instant until which the message is held locked in the queue/subscription. When the lock expires, the DeliveryCount is incremented and the message is again available for retrieval. This property is read-only.
    
    Returns:
    
    the instant at which the lock of this message expires if the message is received using PEEKLOCK mode. Otherwise it returns null.
    
    See Also:
    
    Message transfers, locks, and settlement
  - getEnqueuedTimeUtc
```
Instant getEnqueuedTimeUtc()
```
    Gets the instant at which this message was enqueued in Azure Service Bus. The UTC instant at which the message has been accepted and stored in the entity. For scheduled messages, this reflects the time when the message was activated. This value can be used as an authoritative and neutral arrival time indicator when the receiver does not want to trust the sender's clock. This property is read-only.
    
    Returns:
    
    the instant at which the message was enqueued in Azure Service Bus
    
    See Also:
    
    Message Sequencing and Timestamps
  - getScheduledEnqueuedTimeUtc
```
@Deprecated
Instant getScheduledEnqueuedTimeUtc()
```
    Deprecated. Replaced by getScheduledEnqueueTimeUtc()
    
    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
  - setScheduledEnqueuedTimeUtc
```
@Deprecated
void setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc)
```
    Deprecated. Replaced by setScheduledEnqueueTimeUtc(Instant)
    
    Sets the scheduled enqueue time of this message.
    
    Parameters:
    
    scheduledEnqueueTimeUtc - the instant at which this message should be enqueued in Azure Service Bus
    
    See Also:
    
    getScheduledEnqueueTimeUtc()
  - getScheduledEnqueueTimeUtc
```
Instant getScheduledEnqueueTimeUtc()
```
    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
  - setScheduledEnqueueTimeUtc
```
void setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc)
```
    Sets the scheduled enqueue time of this message.
    
    Parameters:
    
    scheduledEnqueueTimeUtc - the instant at which this message should be enqueued in Azure Service Bus
    
    See Also:
    
    getScheduledEnqueueTimeUtc()
  - getSequenceNumber
```
long getSequenceNumber()
```
    Gets the unique number assigned to a message by Service Bus. The sequence number is a unique 64-bit integer assigned to a message as it is accepted and stored by the broker and functions as its true identifier. For partitioned entities, the topmost 16 bits reflect the partition identifier. Sequence numbers monotonically increase and are gapless. They roll over to 0 when the 48-64 bit range is exhausted. This property is read-only.
    
    Returns:
    
    sequence number of this message
    
    See Also:
    
    Message Sequencing and Timestamps
  - getSessionId
```
String getSessionId()
```
    Gets the session identifier for a session-aware entity. For session-aware entities, this application-defined value specifies the session affiliation of the message. Messages with the same session identifier are subject to summary locking and enable exact in-order processing and demultiplexing. For session-unaware entities, this value is ignored.
    
    Returns:
    
    session id of this message
    
    See Also:
    
    Message Sessions
  - setSessionId
```
void setSessionId(String sessionId)
```
    Sets the session identifier for a session-aware entity.
    
    Parameters:
    
    sessionId - session id of this message
    
    See Also:
    
    getSessionId()
  - getBody
```
@Deprecated
byte[] getBody()
```
    Deprecated. Message body need not just a byte array. Replaced by getMessageBody()
    
    Gets the body of this message as a byte array. It is up to client applications to decode the bytes.
    
    Returns:
    
    body of this message
    
    See Also:
    
    Messages, payloads, and serialization
  - setBody
```
@Deprecated
void setBody(byte[] body)
```
    Deprecated. Message body need not just a byte array. Replaced by setMessageBody(MessageBody)
    
    Sets the body of this message as a byte array.
    
    Parameters:
    
    body - body of this message
    
    See Also:
    
    getBody()
  - getMessageBody
```
MessageBody getMessageBody()
```
    Gets the body of this message. Client applications should extract message content based on body type.
    
    Returns:
    
    body of this message
    
    See Also:
    
    Messages, payloads, and serialization
  - setMessageBody
```
void setMessageBody(MessageBody body)
```
    Sets the body of this message.
    
    Parameters:
    
    body - body of this message
    
    See Also:
    
    getMessageBody()
  - getProperties
```
Map<String,Object> getProperties()
```
    Gets the map of user application properties of this message. Client applications can set user properties (headers) on the message using this map.
    
    Returns:
    
    the map of user application properties of this message
    
    See Also:
    
    Messages, payloads, and serialization
  - setProperties
```
void setProperties(Map<String,Object> properties)
```
    Sets the map of user application properties of this message. Client applications can set user properties on the message using this map.
    
    Parameters:
    
    properties - the map of user application properties of this message
    
    See Also:
    
    getProperties()
  - getCorrelationId
```
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
```
void setCorrelationId(String correlationId)
```
    Sets a correlation identifier.
    
    Parameters:
    
    correlationId - correlation Id of this message
    
    See Also:
    
    getCorrelationId()
  - getTo
```
String getTo()
```
    Gets the "to" address.
    
    Returns:
    
    To property value of this message
  - setTo
```
void 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
  - getReplyTo
```
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
```
void setReplyTo(String replyTo)
```
    Sets the address of an entity to send replies to.
    
    Parameters:
    
    replyTo - ReplyTo property value of this message
    
    See Also:
    
    getReplyTo()
  - getLabel
```
String getLabel()
```
    Gets the application specific message label. This property enables the application to indicate the purpose of the message to the receiver in a standardized fashion, similar to an email subject line. The mapped AMQP property is "subject".
    
    Returns:
    
    Label property value of this message
  - setLabel
```
void setLabel(String label)
```
    Sets an application specific message label.
    
    Parameters:
    
    label - Label property value of this message
    
    See Also:
    
    getLabel()
  - getReplyToSessionId
```
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
```
void setReplyToSessionId(String replyToSessionId)
```
    Gets or sets a session identifier augmenting the ReplyTo address.
    
    Parameters:
    
    replyToSessionId - ReplyToSessionId property value of this message
  - getPartitionKey
```
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:
    
    partition key of this message
    
    See Also:
    
    Partitioned entities
  - setPartitionKey
```
void setPartitionKey(String partitionKey)
```
    Sets a partition key for sending a message to a partitioned entity
    
    Parameters:
    
    partitionKey - partition key of this message
    
    See Also:
    
    getPartitionKey()
  - getViaPartitionKey
```
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 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
```
void 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
    
    See Also:
    
    getViaPartitionKey()
  - getDeadLetterSource
```
String getDeadLetterSource()
```
    Gets the name of the queue or subscription that this message was enqueued on, before it was deadlettered. This value is only set in messages that have been dead-lettered and subsequently auto-forwarded from the dead-letter queue to another entity. Indicates the entity in which the message was dead-lettered. This property is read-only.
    
    Returns:
    
    dead letter source of this message
    
    See Also:
    
    Dead-letter queues
  - getLockToken
```
UUID getLockToken()
```
    Gets the lock token for the current message. The lock token is a reference to the lock that is being held by the broker in PEEKLOCK mode. Locks are used to explicitly settle messages as explained in the product documentation in more detail. The token can also be used to pin the lock permanently through the Deferral API and, with that, take the message out of the regular delivery state flow. This property is read-only.
    
    Returns:
    
    lock token of this message.
    
    See Also:
    
    Message transfers, locks, and settlement
  - createCopy
```
IMessage createCopy()
```
    Creates a shallow copy of this message.
    
    Returns:
    
    copy of this message

Interface IMessage

Method Summary

Method Detail

getDeliveryCount

getMessageId

setMessageId

getTimeToLive

setTimeToLive

getContentType

setContentType

getExpiresAtUtc

getLockedUntilUtc

getEnqueuedTimeUtc

getScheduledEnqueuedTimeUtc

setScheduledEnqueuedTimeUtc

getScheduledEnqueueTimeUtc

setScheduledEnqueueTimeUtc

getSequenceNumber

getSessionId

setSessionId

getBody

setBody

getMessageBody

setMessageBody

getProperties

setProperties

getCorrelationId

setCorrelationId

getTo

setTo

getReplyTo

setReplyTo

getLabel

setLabel

getReplyToSessionId

setReplyToSessionId

getPartitionKey

setPartitionKey

getViaPartitionKey

setViaPartitionKey

getDeadLetterSource

getLockToken

createCopy