ServiceBusMessage Klasse

Paket:

com.azure.messaging.servicebus

Maven-Artefakt:

com.azure:azure-messaging-servicebus:7.17.0

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

public class ServiceBusMessage

Die Datenstruktur, die die an Service Bus gesendete Nachricht kapselt. Die Nachrichtenstruktur wird in der Produktdokumentation ausführlich erläutert.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
ServiceBusMessage(byte[] body)	Erstellt einen ServiceBusMessage mit dem angegebenen Bytearraytext.
ServiceBusMessage(AmqpMessageBody amqpMessageBody)	Dieser Konstruktor bietet eine einfache Möglichkeit zum Erstellen ServiceBusMessage mit Nachrichtentext als AMQP-Datentypen SEQUENCE und VALUE.
ServiceBusMessage(BinaryData body)	Erstellt einen ServiceBusMessage , der den bodyenthält. Stellt BinaryData verschiedene praktische API zur Darstellung des Bytearrays bereit.
ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)	Erstellt mithilfe von ServiceBusMessage Eigenschaften aus receivedMessage.
ServiceBusMessage(String body)	Erstellt einen ServiceBusMessage mit einem UTF-8 codierten Text.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
ServiceBusMessage	addContext(String key, Object value) Fügt dem vorhandenen Kontext in Message ein neues Schlüsselwertpaar hinzu.
Map<String,Object>	getApplicationProperties() Ruft den Satz von Freiformeigenschaften ServiceBusMessage ab, die zum Übergeben von Metadaten verwendet werden können, die ServiceBusMessage während Service Bus-Vorgängen zugeordnet sind.
BinaryData	getBody() Ruft die tatsächliche Nutzlast ab, die ServiceBusMessagevon umschlossen wird.
String	getContentType() Ruft den Inhaltstyp der Nachricht ab.
String	getCorrelationId() Ruft einen Korrelationsbezeichner ab.
String	getMessageId() Ruft die Nachrichten-ID ab.
String	getPartitionKey() Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität ab.
AmqpAnnotatedMessage	getRawAmqpMessage() Ruft das AmqpAnnotatedMessage ab.
String	getReplyTo() Ruft die Adresse einer Entität ab, an die Antworten gesendet werden sollen.
String	getReplyToSessionId() Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.
OffsetDateTime	getScheduledEnqueueTime() Ruft die geplante Queuezeit dieser Nachricht ab.
String	getSessionId() Ruft den Sitzungsbezeichner für eine sitzungsfähige Entität ab.
String	getSubject() Ruft den Betreff für die Nachricht ab.
Duration	getTimeToLive() Ruft die Dauer ab, bevor diese Nachricht abläuft.
String	getTo() Ruft die "to"-Adresse ab.
ServiceBusMessage	setContentType(String contentType) Legt den Inhaltstyp von fest ServiceBusMessage.
ServiceBusMessage	setCorrelationId(String correlationId) Legt einen Korrelationsbezeichner fest.
ServiceBusMessage	setMessageId(String messageId) Legt die Nachrichten-ID fest.
ServiceBusMessage	setPartitionKey(String partitionKey) Legt einen Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität fest.
ServiceBusMessage	setReplyTo(String replyTo) Legt die Adresse einer Entität fest, an die Antworten gesendet werden sollen.
ServiceBusMessage	setReplyToSessionId(String replyToSessionId) Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.
ServiceBusMessage	setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime) Legt die geplante Queuezeit dieser Nachricht fest.
ServiceBusMessage	setSessionId(String sessionId) Legt den Sitzungsbezeichner für eine sitzungsfähige Entität fest.
ServiceBusMessage	setSubject(String subject) Legt den Betreff für die Nachricht fest.
ServiceBusMessage	setTimeToLive(Duration timeToLive) Legt die Dauer fest, bis diese Nachricht abläuft.
ServiceBusMessage	setTo(String to) Legt die Adresse "an" fest.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

ServiceBusMessage

public ServiceBusMessage(byte[] body)

Erstellt einen ServiceBusMessage mit dem angegebenen Bytearraytext.

Parameters:

body - Der Inhalt der Service Bus-Nachricht.

ServiceBusMessage

public ServiceBusMessage(AmqpMessageBody amqpMessageBody)

Dieser Konstruktor bietet eine einfache Möglichkeit zum Erstellen ServiceBusMessage mit Nachrichtentext als AMQP-Datentypen SEQUENCE und VALUE. Im Fall von SEQUENCEunterstützt tt derzeit nur das Senden und Empfangen einer AMQP-Sequenz. Wenn Sie nachrichten mit Einzelbytearray- oder String-Daten senden, können Sie auch einen anderen Konstruktor verwenden.

Parameters:

amqpMessageBody - amqp-Nachrichtentext.

ServiceBusMessage

public ServiceBusMessage(BinaryData body)

Erstellt einen ServiceBusMessage , der den bodyenthält. Stellt BinaryData verschiedene praktische API zur Darstellung des Bytearrays bereit. Es bietet auch eine Möglichkeit zum Serialisieren Object in BinaryData.

Parameters:

body - Die daten, die für diese ServiceBusMessagefestgelegt werden sollen.

ServiceBusMessage

public ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)

Erstellt mithilfe von ServiceBusMessage Eigenschaften aus receivedMessage. Dies wird normalerweise verwendet, wenn ein an eine ServiceBusReceivedMessage andere Entität gesendet werden muss.

Parameters:

receivedMessage - Die empfangene Nachricht, aus der eine neue Nachricht erstellt werden soll.

ServiceBusMessage

public ServiceBusMessage(String body)

Erstellt einen ServiceBusMessage mit einem UTF-8 codierten Text.

Parameters:

body - Der Inhalt der Service Bus-Nachricht.

Details zur Methode

addContext

public ServiceBusMessage addContext(String key, Object value)

Fügt dem vorhandenen Kontext in Message ein neues Schlüsselwertpaar hinzu.

Parameters:

key - Der Schlüssel für dieses Kontextobjekt

value - Der Wert für dieses Kontextobjekt.

Returns:

Der aktualisierte ServiceBusMessage.

getApplicationProperties

public Map getApplicationProperties()

Ruft den Satz von Freiformeigenschaften ServiceBusMessage ab, die zum Übergeben von Metadaten verwendet werden können, die ServiceBusMessage während Service Bus-Vorgängen zugeordnet sind. Ein gängiger Anwendungsfall für getApplicationProperties() ist das Zuordnen von Serialisierungshinweisen für die getBody() Als Hilfe für Verbraucher, die die Binärdaten deserialisieren möchten.

Returns:

Diesem ServiceBusMessagezugeordnete Anwendungseigenschaften.

getBody

public BinaryData getBody()

Ruft die tatsächliche Nutzlast ab, die ServiceBusMessagevon umschlossen wird.

Das BinaryData umschließt das Bytearray und ist eine Abstraktion über viele verschiedene Arten, wie es dargestellt werden kann. Es bietet praktische APIs zum Serialisieren/Deserialisieren des Objekts.

Wenn die Mittel zum Deserialisieren der Rohdaten für Consumer nicht sichtbar sind, besteht eine gängige Technik darin, beim Erstellen des Ereignisses getApplicationProperties() zu verwenden, Serialisierungshinweise als Hilfe für Consumer zu zuordnen, die die Binärdaten deserialisieren möchten.

Returns:

Binärdaten, die die Nutzlast darstellen.

getContentType

public String getContentType()

Ruft den Inhaltstyp der Nachricht ab.

Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor dem Format von RFC2045, Abschnitt 5 folgt, z. B. "application/json".

Returns:

Der Inhaltstyp des ServiceBusMessage.

getCorrelationId

public String getCorrelationId()

Ruft einen Korrelationsbezeichner ab.

Ermöglicht einer Anwendung, einen Kontext für die Nachricht zum Zweck der Korrelation anzugeben, z.B. die MessageId einer Nachricht, auf die geantwortet wird.

Returns:

Die Korrelations-ID dieser Nachricht.

getMessageId

public String getMessageId()

Ruft die Nachrichten-ID ab.

Der Nachrichtenbezeichner ist ein von der Anwendung definierter Wert, der die Nachricht und ihre Nutzlast eindeutig identifiziert. Der Bezeichner ist eine Zeichenfolge in freier Form und kann eine GUID oder einen aus dem Anwendungskontext abgeleiteten Bezeichner widerspiegeln. Wenn sie aktiviert ist, identifiziert und entfernt das Feature zur doppelten Erkennung die zweite und weitere Übermittlung von Nachrichten mit demselben messageId.

Returns:

ID des ServiceBusMessage.

getPartitionKey

public String getPartitionKey()

Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität ab.

Für partitionierte Entitäten ermöglicht das Festlegen dieses Werts, verwandte Nachrichten derselben internen Partition zuzuweisen, sodass die Reihenfolge der Übermittlung ordnungsgemäß aufgezeichnet wird. Die Partition wird von einer Hashfunktion über diesen Wert ausgewählt und kann nicht direkt ausgewählt werden. Bei sitzungsfähigen Entitäten überschreibt die getSessionId() -Eigenschaft diesen Wert.

Returns:

Der Partitionsschlüssel dieser Nachricht.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Ruft das AmqpAnnotatedMessage ab.

Returns:

Die unformatierte AMQP-Nachricht.

getReplyTo

public String getReplyTo()

Ruft die Adresse einer Entität ab, an die Antworten gesendet werden sollen.

Dieser optionale und von der Anwendung definierte Wert ist eine Standardmethode, einen Antwortpfad zum Empfänger der Nachricht auszudrücken. Wenn ein Absender eine Antwort erwartet, legt er den Wert auf den absoluten oder relativen Pfad der Warteschlange oder des Themas fest, an den bzw. das die Antwort gesendet werden soll.

Returns:

ReplyTo-Eigenschaftswert dieser Nachricht

getReplyToSessionId

public String getReplyToSessionId()

Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.

Dieser Wert erweitert die getReplyTo() Informationen und gibt an, welche sessionId für die Antwort festgelegt werden soll, wenn sie an die Antwortentität gesendet wird.

Returns:

Der getReplyToGroupId Eigenschaftswert dieser Nachricht.

getScheduledEnqueueTime

public OffsetDateTime getScheduledEnqueueTime()

Ruft die geplante Queuezeit dieser Nachricht ab.

Dieser Wert wird für die verzögerte Nachrichtenverfügbarkeit verwendet. Die Nachricht wird der Warteschlange sicher hinzugefügt, gilt aber nicht als aktiv und kann daher erst nach der geplanten Warteschlange abgerufen werden. Beachten Sie, dass die Nachricht möglicherweise nicht zur genau angegebenen datetime aktiviert (enqueued) wird; Die tatsächliche Aktivierungszeit hängt von der Workload und dem Zustand der Warteschlange ab.

Returns:

datum, zu dem die Nachricht in Azure Service Bus

getSessionId

public String getSessionId()

Ruft den Sitzungsbezeichner für eine sitzungsfähige Entität ab.

Bei sitzungsabhängigen Entitäten gibt dieser von der Anwendung definierte Wert die Sitzungszugehörigkeit der Nachricht an. Nachrichten mit demselben Sitzungsbezeichner unterliegen einer zusammenfassenden Sperre und ermöglichen eine Verarbeitung in exakter Reihenfolge und Demultiplexing. Bei nicht sitzungsabhängigen Entitäten wird dieser Wert ignoriert. Siehe Nachrichtensitzungen.

Returns:

Die Sitzungs-ID von ServiceBusMessage.

getSubject

public String getSubject()

Ruft den Betreff für die Nachricht ab.

Diese Eigenschaft ermöglicht der Anwendung, dem Empfänger auf standardisierte Weise den Zweck der Nachricht anzuzeigen, ähnlich einer Betreffzeile für E-Mails. Die zugeordnete AMQP-Eigenschaft ist "subject".

Returns:

Der Betreff für die Nachricht.

getTimeToLive

public Duration getTimeToLive()

Ruft die Dauer ab, bevor diese Nachricht abläuft.

Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, ab dem Moment, an dem die Nachricht vom Broker akzeptiert und gespeichert wurde, wie in getScheduledEnqueueTime()erfasst. Wenn er nicht explizit festgelegt wird, ist der angenommene Wert der DefaultTimeToLive-Satz für die jeweilige Warteschlange oder das jeweilige Thema. Ein TimeToLive-Wert auf Nachrichtenebene darf nicht länger als die DefaultTimeToLive-Einstellung der Entität sein und wird automatisch angepasst, falls dies doch der Fall ist.

Returns:

Gültigkeitsdauer dieser Nachricht

getTo

public String getTo()

Ruft die "to"-Adresse ab.

Diese Eigenschaft ist für die künftige Verwendung in Routingszenarien reserviert und wird derzeit vom Broker selbst ignoriert. Anwendungen können diesen Wert in regelgesteuerten Szenarien zur automatischen Weiterleitungsverkettung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

Returns:

Eigenschaftswert "To" dieser Nachricht

setContentType

public ServiceBusMessage setContentType(String contentType)

Legt den Inhaltstyp von fest ServiceBusMessage.

Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor dem Format von RFC2045, Abschnitt 5 folgt, z. B. "application/json".

Parameters:

contentType - RFC2045 Inhaltstypdeskriptor der Nachricht.

Returns:

Der aktualisierte ServiceBusMessage.

setCorrelationId

public ServiceBusMessage setCorrelationId(String correlationId)

Legt einen Korrelationsbezeichner fest.

Parameters:

correlationId - Korrelations-ID dieser Nachricht

Returns:

Der aktualisierte ServiceBusMessage.

setMessageId

public ServiceBusMessage setMessageId(String messageId)

Legt die Nachrichten-ID fest.

Parameters:

messageId - Die festzulegende Nachrichten-ID.

Returns:

Der aktualisierte ServiceBusMessage.

setPartitionKey

public ServiceBusMessage setPartitionKey(String partitionKey)

Legt einen Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität fest.

Parameters:

partitionKey - Der Partitionsschlüssel dieser Nachricht.

Returns:

Der aktualisierte ServiceBusMessage.

setReplyTo

public ServiceBusMessage setReplyTo(String replyTo)

Legt die Adresse einer Entität fest, an die Antworten gesendet werden sollen.

Parameters:

replyTo - ReplyTo-Eigenschaftswert dieser Nachricht

Returns:

Der aktualisierte ServiceBusMessage.

setReplyToSessionId

public ServiceBusMessage setReplyToSessionId(String replyToSessionId)

Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.

Parameters:

replyToSessionId - Der ReplyToGroupId-Eigenschaftswert dieser Nachricht.

Returns:

Der aktualisierte ServiceBusMessage.

setScheduledEnqueueTime

public ServiceBusMessage setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime)

Legt die geplante Queuezeit dieser Nachricht fest. Ein null wird nicht festgelegt. Wenn dieser Wert nicht festgelegt werden muss, kann der Wert mithilfe des AmqpAnnotatedMessage#getMessageAnnotations() Schlüssels AmqpMessageConstant#SCHEDULED_ENQUEUE_UTC_TIME_NAMEentfernt werden.

Parameters:

scheduledEnqueueTime - die Datumstime, zu der diese Nachricht in Azure Service Bus eingereiht werden soll.

Returns:

Der aktualisierte ServiceBusMessage.

setSessionId

public ServiceBusMessage setSessionId(String sessionId)

Legt den Sitzungsbezeichner für eine sitzungsfähige Entität fest.

Parameters:

sessionId - Der festzulegende Sitzungsbezeichner.

Returns:

Der aktualisierte ServiceBusMessage.

setSubject

public ServiceBusMessage setSubject(String subject)

Legt den Betreff für die Nachricht fest.

Parameters:

subject - Der anwendungsspezifische Betreff.

Returns:

Das aktualisierte ServiceBusMessage Objekt.

setTimeToLive

public ServiceBusMessage setTimeToLive(Duration timeToLive)

Legt die Dauer fest, bis diese Nachricht abläuft.

Parameters:

timeToLive - Gültigkeitsdauer dieser Nachricht

Returns:

Der aktualisierte ServiceBusMessage.

setTo

public ServiceBusMessage setTo(String to)

Legt die Adresse "an" fest.

Diese Eigenschaft ist für die künftige Verwendung in Routingszenarien reserviert und wird derzeit vom Broker selbst ignoriert. Anwendungen können diesen Wert in regelgesteuerten Szenarien zur automatischen Weiterleitungsverkettung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

Parameters:

to - Zum Eigenschaftswert dieser Nachricht.

Returns:

Der aktualisierte ServiceBusMessage.